diff options
| author | Kevin Burke <kevin@twilio.com> | 2013-06-12 15:53:09 -0700 |
|---|---|---|
| committer | Kevin Burke <kevin@twilio.com> | 2013-06-12 15:53:09 -0700 |
| commit | a6415cf8956cce8a07b8821b9a4dbb703cd1750c (patch) | |
| tree | 76e678466a92186ea097acad7379438503ba88c6 /docs/user | |
| parent | df935f5b03c810cf893a598f4c363ae85fec9b23 (diff) | |
| download | python-requests-a6415cf8956cce8a07b8821b9a4dbb703cd1750c.tar.gz | |
Link to the actual exception references
Sphinx has a neat cross-referencing feature where if you include the tilde
character in front of a :py: class, it'll link to the full object but provide
only the last part of class name in the text. For more info see
http://sphinx-doc.org/domains.html#cross-referencing-syntax
Diffstat (limited to 'docs/user')
| -rw-r--r-- | docs/user/quickstart.rst | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 1e365871..59d75ccb 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -399,15 +399,16 @@ Errors and Exceptions --------------------- In the event of a network problem (e.g. DNS failure, refused connection, etc), -Requests will raise a :class:`ConnectionError` exception. +Requests will raise a :class:`~requests.exceptions.ConnectionError` exception. -In the event of the rare invalid HTTP response, Requests will raise -an :class:`HTTPError` exception. +In the event of the rare invalid HTTP response, Requests will raise an +:class:`~requests.exceptions.HTTPError` exception. -If a request times out, a :class:`Timeout` exception is raised. +If a request times out, a :class:`~requests.exceptions.Timeout` exception is +raised. If a request exceeds the configured number of maximum redirections, a -:class:`TooManyRedirects` exception is raised. +:class:`~requests.exceptions.TooManyRedirects` exception is raised. All exceptions that Requests explicitly raises inherit from :class:`requests.exceptions.RequestException`. |
