Correctly reflect redirection behaviour.

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 #504.
This commit is contained in:
Cory Benfield
2012-05-17 19:25:35 +01:00
parent 45506d1f39
commit 36fd8da1c0
+5 -5
View File
@@ -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::
@@ -375,8 +375,8 @@ 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
@@ -384,7 +384,7 @@ handling with the ``allow_redirects`` parameter::
>>> 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)