diff options
author | Lorenz Diener <[email protected]> | 2017-12-13 17:11:45 +0100 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2017-12-13 17:11:45 +0100 |
commit | c06baa13b30fc5ce058940e681305f6c03dc0048 (patch) | |
tree | 5533f3cfb8e47c588383ea411ac10c560eec371f /docs | |
parent | d28b5725f4d239dd7baad991cff287916cc2532e (diff) | |
download | mastodon.py-c06baa13b30fc5ce058940e681305f6c03dc0048.tar.gz |
Update verify_credentials docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index dfd91ab..1d8f138 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -134,7 +134,7 @@ If you are only interested in the fact an error was raised somewhere in | |||
134 | Mastodon.py, and not the details, this is the exception you can catch. | 134 | Mastodon.py, and not the details, this is the exception you can catch. |
135 | 135 | ||
136 | `MastodonIllegalArgumentError` is generally a programming problem - you asked the | 136 | `MastodonIllegalArgumentError` is generally a programming problem - you asked the |
137 | API to do something obviously invalid (i.e. specify a privacy scope that does | 137 | API to do something obviously invalid (i.e. specify a privacy option that does |
138 | not exist). | 138 | not exist). |
139 | 139 | ||
140 | `MastodonFileNotFoundError` and `MastodonNetworkError` are IO errors - could be you | 140 | `MastodonFileNotFoundError` and `MastodonNetworkError` are IO errors - could be you |
@@ -176,8 +176,17 @@ User dicts | |||
176 | 'header': # URL for their header image, can be animated | 176 | 'header': # URL for their header image, can be animated |
177 | 'avatar_static': # URL for their avatar, never animated | 177 | 'avatar_static': # URL for their avatar, never animated |
178 | 'header_static': # URL for their header image, never animated | 178 | 'header_static': # URL for their header image, never animated |
179 | 'source': # Additional information - only present for user dict returned from account_verify_credentials() | ||
179 | } | 180 | } |
180 | 181 | ||
182 | mastodon.account_verify_credentials()["source"] | ||
183 | # Returns the following dictionary: | ||
184 | { | ||
185 | 'privacy': # The users default visibility setting ("private", "unlisted" or "public") | ||
186 | 'sensitive': # Denotes whether user media should be marked sensitive by default | ||
187 | 'note': # Plain text version of the users bio | ||
188 | } | ||
189 | |||
181 | Toot dicts | 190 | Toot dicts |
182 | ~~~~~~~~~~ | 191 | ~~~~~~~~~~ |
183 | .. code-block:: python | 192 | .. code-block:: python |