diff options
-rw-r--r-- | docs/index.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index a9ecf49..2d61f14 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -87,6 +87,7 @@ Returns a single toot dict for the given status. | |||
87 | .. automethod:: Mastodon.status_context | 87 | .. automethod:: Mastodon.status_context |
88 | 88 | ||
89 | .. code-block:: python | 89 | .. code-block:: python |
90 | |||
90 | mastodon.status_context(<numerical id>) | 91 | mastodon.status_context(<numerical id>) |
91 | # Returns | 92 | # Returns |
92 | { | 93 | { |
@@ -115,7 +116,9 @@ their relationships. | |||
115 | .. automethod:: Mastodon.account_verify_credentials | 116 | .. automethod:: Mastodon.account_verify_credentials |
116 | 117 | ||
117 | These methods return an account dict: | 118 | These methods return an account dict: |
119 | |||
118 | .. code-block:: python | 120 | .. code-block:: python |
121 | |||
119 | mastodon.account(<numerical id>) | 122 | mastodon.account(<numerical id>) |
120 | # Returns | 123 | # Returns |
121 | { | 124 | { |
@@ -157,7 +160,9 @@ interact with already posted statuses. | |||
157 | .. automethod:: Mastodon.status_unfavourite | 160 | .. automethod:: Mastodon.status_unfavourite |
158 | 161 | ||
159 | These methods return a toot dict: | 162 | These methods return a toot dict: |
163 | |||
160 | .. code-block:: python | 164 | .. code-block:: python |
165 | |||
161 | mastodon.toot("Hello from Python") | 166 | mastodon.toot("Hello from Python") |
162 | # Returns the following dictionary: | 167 | # Returns the following dictionary: |
163 | { | 168 | { |
@@ -180,7 +185,9 @@ These methods return a toot dict: | |||
180 | 185 | ||
181 | .. automethod:: Mastodon.status_delete | 186 | .. automethod:: Mastodon.status_delete |
182 | Returns an empty dict: | 187 | Returns an empty dict: |
188 | |||
183 | .. code-block:: python | 189 | .. code-block:: python |
190 | |||
184 | mastodon.delete_status(<numerical id>) | 191 | mastodon.delete_status(<numerical id>) |
185 | # Returns | 192 | # Returns |
186 | {} | 193 | {} |
@@ -191,7 +198,9 @@ These functions allow you to interact with other accounts: To (un)follow and | |||
191 | (un)block. | 198 | (un)block. |
192 | 199 | ||
193 | They return a relationship dict: | 200 | They return a relationship dict: |
201 | |||
194 | .. code-block:: python | 202 | .. code-block:: python |
203 | |||
195 | mastodon.account_follow(<numerical id>) | 204 | mastodon.account_follow(<numerical id>) |
196 | # Returns | 205 | # Returns |
197 | { | 206 | { |
@@ -215,7 +224,9 @@ to attach media to statuses. | |||
215 | .. automethod:: Mastodon.media_post | 224 | .. automethod:: Mastodon.media_post |
216 | 225 | ||
217 | Returns a media dict: | 226 | Returns a media dict: |
227 | |||
218 | .. code-block:: python | 228 | .. code-block:: python |
229 | |||
219 | mastodon.media_post("image.jpg", "image/jpeg") | 230 | mastodon.media_post("image.jpg", "image/jpeg") |
220 | # Returns | 231 | # Returns |
221 | { | 232 | { |