aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2017-12-14 00:30:51 +0100
committerLorenz Diener <[email protected]>2017-12-14 00:30:51 +0100
commit886bb490395e226c5166f4509d7f18831f5c3850 (patch)
tree52081559b30554d7d931bc40ba7bca7819117ac5 /docs
parent94fb509bac7f87425c6a6dde54f5b56981ddc2bd (diff)
downloadmastodon.py-886bb490395e226c5166f4509d7f18831f5c3850.tar.gz
Fix doc scrollyness
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst23
1 files changed, 15 insertions, 8 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 3e6682e..03c8512 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -180,7 +180,8 @@ User dicts
180 'header': # URL for their header image, can be animated 180 'header': # URL for their header image, can be animated
181 'avatar_static': # URL for their avatar, never animated 181 'avatar_static': # URL for their avatar, never animated
182 'header_static': # URL for their header image, never animated 182 'header_static': # URL for their header image, never animated
183 'source': # Additional information - only present for user dict returned from account_verify_credentials() 183 'source': # Additional information - only present for user dict returned
184 # from account_verify_credentials()
184 } 185 }
185 186
186 mastodon.account_verify_credentials()["source"] 187 mastodon.account_verify_credentials()["source"]
@@ -223,7 +224,8 @@ Toot dicts
223 '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
224 'application': # Application dict for the client used to post the toot 225 'application': # Application dict for the client used to post the toot
225 'language': # The language of the toot, if specified by the server. 226 'language': # The language of the toot, if specified by the server.
226 'muted': # Boolean denoting whether the user has muted this status by way of conversation muting 227 'muted': # Boolean denoting whether the user has muted this status by
228 # way of conversation muting
227 } 229 }
228 230
229Mention dicts 231Mention dicts
@@ -276,8 +278,10 @@ Relationship dicts
276 'followed_by': # Boolean denoting whether the specified user follows the logged-in user 278 'followed_by': # Boolean denoting whether the specified user follows the logged-in user
277 'blocking': # Boolean denoting whether the logged-in user has blocked the specified user 279 'blocking': # Boolean denoting whether the logged-in user has blocked the specified user
278 'muting': # Boolean denoting whether the logged-in user has muted the specified user 280 'muting': # Boolean denoting whether the logged-in user has muted the specified user
279 'requested': # Boolean denoting whether the logged-in user has sent the specified user a follow request 281 'requested': # Boolean denoting whether the logged-in user has sent the specified
280 'domain_blocking': # Boolean denoting whether the logged-in user has blocked the specified users domain 282 # user a follow request
283 'domain_blocking': # Boolean denoting whether the logged-in user has blocked the
284 # specified users domain
281 } 285 }
282 286
283Notification dicts 287Notification dicts
@@ -338,7 +342,8 @@ Media dicts
338 'remote_url': # The remote URL for the media (if the image is from a remote instance) 342 'remote_url': # The remote URL for the media (if the image is from a remote instance)
339 'preview_url': # The URL for the media preview 343 'preview_url': # The URL for the media preview
340 'text_url': # The display text for the media (what shows up in toots) 344 'text_url': # The display text for the media (what shows up in toots)
341 'meta': # Dictionary of two image metadata dicts (see below), 'original' and 'small' (preview) 345 'meta': # Dictionary of two image metadata dicts (see below),
346 # 'original' and 'small' (preview)
342 } 347 }
343 348
344 # Metadata dicts: 349 # Metadata dicts:
@@ -403,7 +408,8 @@ Instance dicts
403 'title': # The instances title 408 'title': # The instances title
404 'uri': # The instances URL 409 'uri': # The instances URL
405 'version': # The instances mastodon version 410 'version': # The instances mastodon version
406 'urls': # Additional URLs dict, presently only 'streaming_api' with the stream websocket address. 411 'urls': # Additional URLs dict, presently only 'streaming_api' with the
412 # stream websocket address.
407 } 413 }
408 414
409Report dicts 415Report dicts
@@ -417,8 +423,9 @@ Report dicts
417 { 423 {
418 'id': # Numerical id of the report 424 'id': # Numerical id of the report
419 'action_taken': # True if a moderator or admin has processed the 425 'action_taken': # True if a moderator or admin has processed the
420 # report, False otherwise. Note that no indication as to what action was taken is given 426 # report, False otherwise. Note that no indication as to
421 # and that an admin simply marking the report as processed and not doing anything else 427 # what action was taken is given and that an admin simply
428 # marking the report as processed and not doing anything else
422 # will set this field to True. 429 # will set this field to True.
423 } 430 }
424 431
Powered by cgit v1.2.3 (git 2.41.0)