Correctly reflect redirection behaviour.
authorCory Benfield <lukasaoz@gmail.com>
Thu, 17 May 2012 18:25:35 +0000 (19:25 +0100)
committerCory Benfield <lukasaoz@gmail.com>
Thu, 17 May 2012 18:25:35 +0000 (19:25 +0100)
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.

docs/user/quickstart.rst

index 36275362776f767fd48f3001d9499447cd075c46..775970e73c4d4668a879f6536a369b9bde103c90 100644 (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)