Skip to content

Commit

Permalink
prepared request docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kenneth Reitz committed Dec 23, 2012
1 parent 6e780fa commit 5f9fecd
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions requests/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ def __repr__(self):
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)
Expand All @@ -213,7 +213,11 @@ def prepare(self):


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
Expand Down

0 comments on commit 5f9fecd

Please sign in to comment.