Merge remote-tracking branch 'refs/remotes/origin/master' into ratelimits

# Conflicts:
#	mastodon/Mastodon.py

1 files changed, 109 insertions, 8 deletions

diff --git a/docs/index.rst b/docs/index.rst
index a91cfb7..e7c9366 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,5 +1,7 @@
 Mastodon.py
 ===========
+.. py:module:: mastodon
+.. py:class: Mastodon
 
 .. code-block:: python
 
@@ -37,14 +39,114 @@ as a single python module. By default, it talks to the
 `Mastodon flagship instance`_, but it can be set to talk to any 
 node running Mastodon.
 
+A note about IDs
+----------------
+Mastodons API uses IDs in several places: User IDs, Toot IDs, ...
+
+While debugging, it might be tempting to copy-paste in IDs from the
+web interface into your code. This will not work, as the IDs on the web
+interface and in the URLs are not the same as the IDs used internally
+in the API, so don't do that.
+
+Return values
+-------------
 Unless otherwise specified, all data is returned as python 
 dictionaries, matching the JSON format used by the API.
-For complete documentation on what every function returns, 
-check the `Mastodon API docs`_, or just play around a bit - the
-format of the data is generally very easy to understand.
 
-.. py:module:: mastodon
-.. py:class: Mastodon
+User dicts
+~~~~~~~~~~
+.. code-block:: python
+
+    mastodon.account(<numerical id>)
+    # Returns the following dictionary:
+    {
+     'display_name': The user's display name
+     'acct': The user's account name as username@domain (@domain omitted for local users)
+     'following_count': How many people they follow
+     'url': Their URL; usually 'https://mastodon.social/users/<acct>'
+     'statuses_count': How many statuses they have
+     'followers_count': How many followers they have
+     'avatar': URL for their avatar
+     'note': Their bio
+     'header': URL for their header image
+     'id': Same as <numerical id>
+     'username': The username (what you @ them with)
+    }
+
+Toot dicts
+~~~~~~~~~~
+.. code-block:: python
+
+   mastodon.toot("Hello from Python")
+   # Returns the following dictionary:
+   {
+    'sensitive': Denotes whether the toot is marked sensitive
+    'created_at': Creation time
+    'mentions': A list of account dicts mentioned in the toot
+    'uri': Descriptor for the toot
+           EG 'tag:mastodon.social,2016-11-25:objectId=<id>:objectType=Status'
+    'tags': A list of hashtag dicts used in the toot
+    'in_reply_to_id': Numerical id of the toot this toot is in response to
+    'id': Numerical id of this toot
+    'reblogs_count': Number of reblogs
+    'favourites_count': Number of favourites
+    'reblog': Denotes whether the toot is a reblog
+    'url': URL of the toot
+    'content': Content of the toot, as HTML: '<p>Hello from Python</p>'
+    'favourited': Denotes whether the logged in user has favourited this toot
+    'account': Account dict for the logged in account
+   }
+
+Relationship dicts
+~~~~~~~~~~~~~~~~~~
+.. code-block:: python
+
+    mastodon.account_follow(<numerical id>)
+    # Returns the following dictionary:
+    {
+     'followed_by': Boolean denoting whether they follow you back
+     'following': Boolean denoting whether you follow them
+     'id': Numerical id (same one as <numerical id>)
+     'blocking': Boolean denoting whether you are blocking them
+    }
+
+Notification dicts
+~~~~~~~~~~~~~~~~~~
+.. code-block:: python
+
+    mastodon.notifications()[0]
+    # Returns the following dictionary:
+    {
+        'id': id of the notification.
+        'type': "mention", "reblog", "favourite" or "follow".
+        'status': In case of "mention", the mentioning status. 
+                  In case of reblog / favourite, the reblogged / favourited status.
+        'account': User dict of the user from whom the notification originates.
+    }
+
+Context dicts
+~~~~~~~~~~~~~
+.. code-block:: python
+
+    mastodon.status_context(<numerical id>)
+    # Returns the following dictionary:
+    {
+     'descendants': A list of toot dicts
+     'ancestors': A list of toot dicts
+    }
+
+Media dicts
+~~~~~~~~~~~
+.. code-block:: python
+
+    mastodon.media_post("image.jpg", "image/jpeg")
+    # Returns the following dictionary:
+    {
+     'text_url': The display text for the media (what shows up in toots)
+     'preview_url': The URL for the media preview
+     'type': Media type, EG 'image'
+     'url': The URL for the media
+    }
 
 App registration and user authentication
 ----------------------------------------
@@ -91,7 +193,6 @@ This function allows you to get information about a users notifications.
 
 .. automethod:: Mastodon.notifications
 
-
 Reading data: Accounts
 ----------------------
 These functions allow you to get information about accounts and
@@ -103,7 +204,6 @@ their relationships.
 .. automethod:: Mastodon.account_following
 .. automethod:: Mastodon.account_followers
 .. automethod:: Mastodon.account_relationships
-.. automethod:: Mastodon.account_suggestions
 .. automethod:: Mastodon.account_search
 
 Writing data: Statuses
@@ -113,11 +213,11 @@ interact with already posted statuses.
 
 .. automethod:: Mastodon.status_post
 .. automethod:: Mastodon.toot
-.. automethod:: Mastodon.status_delete
 .. automethod:: Mastodon.status_reblog
 .. automethod:: Mastodon.status_unreblog
 .. automethod:: Mastodon.status_favourite
 .. automethod:: Mastodon.status_unfavourite
+.. automethod:: Mastodon.status_delete
 
 Writing data: Accounts
 ----------------------
@@ -137,6 +237,7 @@ to attach media to statuses.
 
 .. automethod:: Mastodon.media_post
 
+
 .. _Mastodon: https://github.com/Gargron/mastodon
 .. _Mastodon flagship instance: http://mastodon.social/
 .. _Mastodon api docs: https://github.com/Gargron/mastodon/wiki/API