aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2016-11-26 00:31:26 +0100
committerLorenz Diener <[email protected]>2016-11-26 00:31:26 +0100
commitddc10c2eee65f111d223492b988e9e960db8a2c1 (patch)
tree3ff9128f62b4f5819f40a08548b3bcd6177f3605 /docs
parent8b80eea8625f9f9e3f13fbdbe28c8157d648e727 (diff)
downloadmastodon.py-ddc10c2eee65f111d223492b988e9e960db8a2c1.tar.gz
Doc update
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst32
1 files changed, 17 insertions, 15 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 5e893fe..2a7aaf2 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -85,21 +85,21 @@ User dicts
85~~~~~~~~~~ 85~~~~~~~~~~
86.. code-block:: python 86.. code-block:: python
87 87
88 mastodon.account(<numerical id>) 88 mastodon.account(<numerical id>)
89 # Returns the following dictionary: 89 # Returns the following dictionary:
90 { 90 {
91 'display_name': The user's display name 91 'display_name': The user's display name
92 'acct': The user's account name as username@domain (@domain omitted for local users) 92 'acct': The user's account name as username@domain (@domain omitted for local users)
93 'following_count': How many people they follow 93 'following_count': How many people they follow
94 'url': Their URL; usually 'https://mastodon.social/users/<acct>' 94 'url': Their URL; usually 'https://mastodon.social/users/<acct>'
95 'statuses_count': How many statuses they have 95 'statuses_count': How many statuses they have
96 'followers_count': How many followers they have 96 'followers_count': How many followers they have
97 'avatar': URL for their avatar 97 'avatar': URL for their avatar
98 'note': Their bio 98 'note': Their bio
99 'header': URL for their header image 99 'header': URL for their header image
100 'id': Same as <numerical id> 100 'id': Same as <numerical id>
101 'username': The username (what you @ them with) 101 'username': The username (what you @ them with)
102 } 102 }
103 103
104Toot dicts 104Toot dicts
105~~~~~~~~~~ 105~~~~~~~~~~
@@ -115,6 +115,8 @@ Toot dicts
115 EG 'tag:mastodon.social,2016-11-25:objectId=<id>:objectType=Status' 115 EG 'tag:mastodon.social,2016-11-25:objectId=<id>:objectType=Status'
116 'tags': A list of hashtag dicts used in the toot 116 'tags': A list of hashtag dicts used in the toot
117 'in_reply_to_id': Numerical id of the toot this toot is in response to 117 'in_reply_to_id': Numerical id of the toot this toot is in response to
118 'media_attachments': list of media dicts of attached files. Only present
119 when there are attached files.
118 'id': Numerical id of this toot 120 'id': Numerical id of this toot
119 'reblogs_count': Number of reblogs 121 'reblogs_count': Number of reblogs
120 'favourites_count': Number of favourites 122 'favourites_count': Number of favourites
Powered by cgit v1.2.3 (git 2.41.0)