diff options
author | Lorenz Diener <[email protected]> | 2017-12-14 10:51:55 +0100 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2017-12-14 10:51:55 +0100 |
commit | 3397939c6f0b67444cd6388fd70705411c40b6c7 (patch) | |
tree | 3ba81130ffa98b7f529625699aa4f7c958d34b2e /docs | |
parent | 58dfdfaec58cc7a4e07d516b4b0b1716a80e4d62 (diff) | |
download | mastodon.py-3397939c6f0b67444cd6388fd70705411c40b6c7.tar.gz |
Improve application docs. Closes #115
Diffstat (limited to 'docs')
-rw-r--r-- | docs/.index.rst.kate-swp | bin | 200 -> 0 bytes | |||
-rw-r--r-- | docs/index.rst | 17 |
2 files changed, 15 insertions, 2 deletions
diff --git a/docs/.index.rst.kate-swp b/docs/.index.rst.kate-swp deleted file mode 100644 index 3982f20..0000000 --- a/docs/.index.rst.kate-swp +++ /dev/null | |||
Binary files differ | |||
diff --git a/docs/index.rst b/docs/index.rst index 2762a6e..4ef5102 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -222,7 +222,8 @@ Toot dicts | |||
222 | 'media_attachments': # A list of media dicts of attached files | 222 | 'media_attachments': # A list of media dicts of attached files |
223 | 'emojis': # A list of custom emojis used in the toot, as Emoji dicts | 223 | 'emojis': # A list of custom emojis used in the toot, as Emoji dicts |
224 | 'tags': # A list of hashtag used in the toot, as Hashtag dicts | 224 | 'tags': # A list of hashtag used in the toot, as Hashtag dicts |
225 | 'application': # Application dict for the client used to post the toot | 225 | 'application': # Application dict for the client used to post the toot (Can be |
226 | # None, for toots made using the web UI). | ||
226 | 'language': # The language of the toot, if specified by the server. | 227 | 'language': # The language of the toot, if specified by the server. |
227 | 'muted': # Boolean denoting whether the user has muted this status by | 228 | 'muted': # Boolean denoting whether the user has muted this status by |
228 | # way of conversation muting | 229 | # way of conversation muting |
@@ -263,7 +264,19 @@ Emoji dicts | |||
263 | 'url': # URL for the emoji image, can be animated | 264 | 'url': # URL for the emoji image, can be animated |
264 | 'static_url': # URL for the emoji image, never animated | 265 | 'static_url': # URL for the emoji image, never animated |
265 | } | 266 | } |
266 | 267 | ||
268 | Application dicts | ||
269 | ~~~~~~~~~~~~~~~~~ | ||
270 | .. _application dict: | ||
271 | |||
272 | .. code-block:: python | ||
273 | |||
274 | { | ||
275 | 'name': # The applications name | ||
276 | 'website': # The applications website | ||
277 | } | ||
278 | |||
279 | |||
267 | Relationship dicts | 280 | Relationship dicts |
268 | ~~~~~~~~~~~~~~~~~~ | 281 | ~~~~~~~~~~~~~~~~~~ |
269 | .. _relationship dict: | 282 | .. _relationship dict: |