diff options
author | Lorenz Diener <[email protected]> | 2018-06-04 15:00:25 +0200 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2018-06-04 15:00:25 +0200 |
commit | 4c7c0c41f4e21dcec9d12810a1b217959e8863b7 (patch) | |
tree | 11bfd195641a84dd010ffc14577a739f3aedcb54 /docs | |
parent | 620687a07922f66e6e278b74050b5384e0131c36 (diff) | |
download | mastodon.py-4c7c0c41f4e21dcec9d12810a1b217959e8863b7.tar.gz |
Document errors more
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index 4bcc70d..32d928f 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -148,17 +148,26 @@ not exist). | |||
148 | 148 | ||
149 | `MastodonFileNotFoundError` and `MastodonNetworkError` are IO errors - could be you | 149 | `MastodonFileNotFoundError` and `MastodonNetworkError` are IO errors - could be you |
150 | specified a wrong URL, could be the internet is down or your hard drive is | 150 | specified a wrong URL, could be the internet is down or your hard drive is |
151 | dying. They inherit from MastodonIOError, for easy catching. | 151 | dying. They inherit from `MastodonIOError`, for easy catching. There is a sub-error |
152 | of `MastodonNetworkError`, `MastodonReadTimeout`, which is thrown when a streaming | ||
153 | API stream times out during reading. | ||
152 | 154 | ||
153 | `MastodonAPIError` is an error returned from the Mastodon instance - the server | 155 | `MastodonAPIError` is an error returned from the Mastodon instance - the server |
154 | has decided it can't fullfill your request (i.e. you requested info on a user that | 156 | has decided it can't fullfill your request (i.e. you requested info on a user that |
155 | does not exist). | 157 | does not exist). It is further split into `MastodonNotFoundError` (API returned 404) |
158 | and `MastodonUnauthorizedError` (API returned 401). Different error codes might exist, | ||
159 | but are not currently handled separately. | ||
160 | |||
161 | `MastodonMalformedEventError` is raised when a streaming API listener receives an | ||
162 | invalid event. There have been reports that this can sometimes happen after prolonged | ||
163 | operation due to an upstream problem in the requests/urllib libraries. | ||
156 | 164 | ||
157 | `MastodonRatelimitError` is raised when you hit an API rate limit. You should try | 165 | `MastodonRatelimitError` is raised when you hit an API rate limit. You should try |
158 | again after a while (see the rate limiting section above). | 166 | again after a while (see the rate limiting section above). |
159 | 167 | ||
160 | `MastodonVersionError` is raised when a version check for an API call fails. | 168 | `MastodonVersionError` is raised when a version check for an API call fails. |
161 | 169 | ||
170 | |||
162 | Return values | 171 | Return values |
163 | ------------- | 172 | ------------- |
164 | Unless otherwise specified, all data is returned as python dictionaries, matching | 173 | Unless otherwise specified, all data is returned as python dictionaries, matching |