From 2a6303e018ab2d0e5925c0afc44d529419bcc9d5 Mon Sep 17 00:00:00 2001 From: David Pursehouse Date: Wed, 16 Jul 2014 10:40:16 +0900 Subject: [PATCH] Docs: Fix :class: and :meth: directives A few instances of the directives were malformed and did not result in hyperlinks in the generated HTML. Change-Id: I94d93de928ee4ff24a48797baf2ac77598a20704 --- docs/user/advanced.rst | 4 ++-- docs/user/quickstart.rst | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst index 6343e48..95dd6be 100644 --- a/docs/user/advanced.rst +++ b/docs/user/advanced.rst @@ -80,7 +80,7 @@ request, and then the request's headers:: Prepared Requests ----------------- -Whenever you receive a :class:`Response ` object +Whenever you receive a :class:`Response ` object from an API call or a Session call, the ``request`` attribute is actually the ``PreparedRequest`` that was used. In some cases you may wish to do some extra work to the body or headers (or anything else really) before sending a @@ -117,7 +117,7 @@ However, the above code will lose some of the advantages of having a Requests :class:`Session ` object. In particular, :class:`Session `-level state such as cookies will not get applied to your request. To get a -:class:`PreparedRequest ` with that state +:class:`PreparedRequest ` with that state applied, replace the call to :meth:`Request.prepare() ` with a call to :meth:`Session.prepare_request() `, like this:: diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 128c578..6bd82f7 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -367,9 +367,10 @@ HEAD. 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. +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:: -- 2.34.1