From: Kenneth Reitz <me@kennethreitz.com>
Date: Sun, 23 Dec 2012 06:21:02 +0000 (-0500)
Subject: prepared request docs
X-Git-Tag: v1.0.4~20
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5f9fecd3aa0ce584eeb1ab7d8211e0f8b510a73e;p=services%2Fpython-requests.git

prepared request docs
---

diff --git a/requests/models.py b/requests/models.py
index 7bbd2b9..17e565a 100644
--- a/requests/models.py
+++ b/requests/models.py
@@ -197,7 +197,7 @@ class Request(RequestHooksMixin):
         return '<Request [%s]>' % (self.method)
 
     def prepare(self):
-        """Constructs a PreparedRequest for transmission and returns it."""
+        """Constructs a :class:`PreparedRequest <PreparedRequest>` for transmission and returns it."""
         p = PreparedRequest()
 
         p.prepare_method(self.method)
@@ -213,7 +213,11 @@ class Request(RequestHooksMixin):
 
 
 class PreparedRequest(RequestEncodingMixin, RequestHooksMixin):
-    """The :class:`PreparedRequest <PreparedRequest>` object."""
+    """The fully mutable :class:`PreparedRequest <PreparedRequest>` object,
+    containing the exact bytes that will be sent to the server.
+
+    Generated from a :class:`Request <Request>` object or manually.
+    """
 
     def __init__(self):
         self.method = None