aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2017-12-14 00:33:22 +0100
committerLorenz Diener <[email protected]>2017-12-14 00:33:22 +0100
commitae58ae77897ab9293ba41a1875aa05246fa48093 (patch)
tree4a1319f1df9ecdfd28d1f02ea5b711bc99e609e1 /docs/index.rst
parent3078a7ac926010f7f69cdb7ef4bb13503d67f350 (diff)
downloadmastodon.py-ae58ae77897ab9293ba41a1875aa05246fa48093.tar.gz
More tiny doc fixing
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 03c8512..2762a6e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -42,11 +42,11 @@ network node. It has an API that allows you to interact with its
42every aspect. This is a simple python wrapper for that api, provided 42every aspect. This is a simple python wrapper for that api, provided
43as a single python module. By default, it talks to the 43as a single python module. By default, it talks to the
44`Mastodon flagship instance`_, but it can be set to talk to any 44`Mastodon flagship instance`_, but it can be set to talk to any
45node running Mastodon by setting api_base_url when creating the 45node running Mastodon by setting `api_base_url` when creating the
46api object (or creating an app). 46api object (or creating an app).
47 47
48Mastodon.py aims to implement the complete public Mastodon API. As 48Mastodon.py aims to implement the complete public Mastodon API. As
49of this time, it is feature complete for Mastodon version 2.0.0. 49of this time, it is feature complete for Mastodon version 2.1.0.
50 50
51A note about rate limits 51A note about rate limits
52------------------------ 52------------------------
@@ -361,7 +361,7 @@ Card dicts
361.. code-block:: python 361.. code-block:: python
362 362
363 mastodon.status_card(<numerical id>): 363 mastodon.status_card(<numerical id>):
364 # Returns the folowing dictionary 364 # Returns the following dictionary
365 { 365 {
366 'url': # The URL of the card. 366 'url': # The URL of the card.
367 'title': # The title of the card. 367 'title': # The title of the card.
@@ -387,7 +387,7 @@ Search result dicts
387.. code-block:: python 387.. code-block:: python
388 388
389 mastodon.search("<query>") 389 mastodon.search("<query>")
390 # Returns the folowing dictionary 390 # Returns the following dictionary
391 { 391 {
392 'accounts': # List of account dicts resulting from the query 392 'accounts': # List of account dicts resulting from the query
393 'hashtags': # List of hashtag dicts resulting from the query 393 'hashtags': # List of hashtag dicts resulting from the query
@@ -401,7 +401,7 @@ Instance dicts
401.. code-block:: python 401.. code-block:: python
402 402
403 mastodon.instance() 403 mastodon.instance()
404 # Returns the folowing dictionary 404 # Returns the following dictionary
405 { 405 {
406 'description': # A brief instance description set by the admin 406 'description': # A brief instance description set by the admin
407 'email': # The admin contact e-mail 407 'email': # The admin contact e-mail
@@ -419,7 +419,7 @@ Report dicts
419.. code-block:: python 419.. code-block:: python
420 420
421 mastodon.reports()[0] 421 mastodon.reports()[0]
422 # Returns the folowing dictionary 422 # Returns the following dictionary
423 { 423 {
424 'id': # Numerical id of the report 424 'id': # Numerical id of the report
425 'action_taken': # True if a moderator or admin has processed the 425 'action_taken': # True if a moderator or admin has processed the
Powered by cgit v1.2.3 (git 2.41.0)