Skip to content

Commit

Permalink
Correctly reflect redirection behaviour.
Browse files Browse the repository at this point in the history
The docs incorrectly listed HEAD as a method that follows redirects by
default: it does not. This commit resolves this issue, and thus resolves
issue psf#504.
  • Loading branch information
Lukasa committed May 17, 2012
1 parent 45506d1 commit 36fd8da
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/user/quickstart.rst
Expand Up @@ -358,8 +358,8 @@ Documentation and examples can be found on the requests-oauth
Redirection and History
-----------------------

Requests will automatically perform location redirection while using
idempotent methods, such as GET.
Requests will automatically perform location redirection while using the GET
and OPTIONS verbs.

GitHub redirects all HTTP requests to HTTPS. We can use the ``history`` method
of the Response object to track redirection. Let's see what Github does::
Expand All @@ -375,16 +375,16 @@ of the Response object to track redirection. Let's see what Github does::
The :class:`Response.history` list contains a list of the
:class:`Request` objects that were created in order to complete the request.

If you're using GET, HEAD, or OPTIONS, you can disable redirection
handling with the ``allow_redirects`` parameter::
If you're using GET or OPTIONS, you can disable redirection handling with the
``allow_redirects`` parameter::

>>> r = requests.get('http://github.com', allow_redirects=False)
>>> r.status_code
301
>>> r.history
[]

If you're using POST, PUT, PATCH, *&c*, you can also explicitly enable
If you're using POST, PUT, PATCH, DELETE or HEAD, you can enable
redirection as well::

>>> r = requests.post('http://github.com', allow_redirects=True)
Expand Down

0 comments on commit 36fd8da

Please sign in to comment.