diff options
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 6439f69..a91cfb7 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -37,8 +37,11 @@ as a single python module. By default, it talks to the | |||
37 | `Mastodon flagship instance`_, but it can be set to talk to any | 37 | `Mastodon flagship instance`_, but it can be set to talk to any |
38 | node running Mastodon. | 38 | node running Mastodon. |
39 | 39 | ||
40 | Unless otherwise specified, all data is returned as python | ||
41 | dictionaries, matching the JSON format used by the API. | ||
40 | For complete documentation on what every function returns, | 42 | For complete documentation on what every function returns, |
41 | check the `Mastodon API docs`_, or just play around a bit. | 43 | check the `Mastodon API docs`_, or just play around a bit - the |
44 | format of the data is generally very easy to understand. | ||
42 | 45 | ||
43 | .. py:module:: mastodon | 46 | .. py:module:: mastodon |
44 | .. py:class: Mastodon | 47 | .. py:class: Mastodon |
@@ -68,6 +71,10 @@ This function allows you to access the timelines a logged in | |||
68 | user could see, as well as hashtag timelines and the public timeline. | 71 | user could see, as well as hashtag timelines and the public timeline. |
69 | 72 | ||
70 | .. automethod:: Mastodon.timeline | 73 | .. automethod:: Mastodon.timeline |
74 | .. automethod:: Mastodon.timeline_home | ||
75 | .. automethod:: Mastodon.timeline_mentions | ||
76 | .. automethod:: Mastodon.timeline_public | ||
77 | .. automethod:: Mastodon.timeline_hashtag | ||
71 | 78 | ||
72 | Reading data: Statuses | 79 | Reading data: Statuses |
73 | ---------------------- | 80 | ---------------------- |
@@ -78,6 +85,13 @@ These functions allow you to get information about single statuses. | |||
78 | .. automethod:: Mastodon.status_reblogged_by | 85 | .. automethod:: Mastodon.status_reblogged_by |
79 | .. automethod:: Mastodon.status_favourited_by | 86 | .. automethod:: Mastodon.status_favourited_by |
80 | 87 | ||
88 | Reading data: Notifications | ||
89 | --------------------------- | ||
90 | This function allows you to get information about a users notifications. | ||
91 | |||
92 | .. automethod:: Mastodon.notifications | ||
93 | |||
94 | |||
81 | Reading data: Accounts | 95 | Reading data: Accounts |
82 | ---------------------- | 96 | ---------------------- |
83 | These functions allow you to get information about accounts and | 97 | These functions allow you to get information about accounts and |