Restructure "Redirection and History" section in quickstart documentation
authorDavid Pursehouse <david.pursehouse@sonymobile.com>
Tue, 15 Jul 2014 09:26:51 +0000 (18:26 +0900)
committerDavid Pursehouse <david.pursehouse@sonymobile.com>
Tue, 15 Jul 2014 09:44:13 +0000 (18:44 +0900)
Change-Id: Ida38d551e8cd0edaeb92d09de411a6f4a3d0578b

docs/user/quickstart.rst

index 28e449774349f4a4fd03f7590f8a04c5bc4de3fb..128c5780dbd610024335676ea2672c8929d08082 100644 (file)
@@ -362,11 +362,16 @@ parameter::
 Redirection and History
 -----------------------
 
-Requests will automatically perform location redirection for all verbs except
+By default Requests will perform location redirection for all verbs except
 HEAD.
 
-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::
+We can use the ``history`` property of the Response object to track redirection.
+
+The :meth:`Response.history` list contains the :class:`Request` objects that
+were created in order to complete the request. The list is sorted from the
+oldest to the most recent request.
+
+For example, GitHub redirects all HTTP requests to HTTPS::
 
     >>> r = requests.get('http://github.com')
     >>> r.url
@@ -376,9 +381,6 @@ of the Response object to track redirection. Let's see what GitHub does::
     >>> r.history
     [<Response [301]>]
 
-The :class:`Response.history` list contains the :class:`Request` objects that
-were created in order to complete the request. The list is sorted from the
-oldest to the most recent request.
 
 If you're using GET, OPTIONS, POST, PUT, PATCH or DELETE, you can disable
 redirection handling with the ``allow_redirects`` parameter::