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

api docs
---

diff --git a/requests/api.py b/requests/api.py
index 0efac8b..4a39211 100644
--- a/requests/api.py
+++ b/requests/api.py
@@ -32,6 +32,12 @@ def request(method, url, **kwargs):
     :param verify: (optional) if ``True``, the SSL cert will be verified. A CA_BUNDLE path can also be provided.
     :param stream: (optional) if ``False``, the response content will be immediately downloaded.
     :param cert: (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair.
+
+    Usage::
+
+      >>> import requests
+      >>> req = requests.request('GET', 'http://httpbin.org/get')
+      <Response [200]>
     """
 
     session = sessions.Session()
diff --git a/requests/models.py b/requests/models.py
index 2ec3373..2cf1b7b 100644
--- a/requests/models.py
+++ b/requests/models.py
@@ -148,6 +148,8 @@ class RequestHooksMixin(object):
 class Request(RequestHooksMixin):
     """A user-created :class:`Request <Request>` object.
 
+    Used to prepare a :class:`PreparedRequest <PreparedRequest>`, which is sent to the server.
+
     :param method: HTTP method to use.
     :param url: URL to send.
     :param headers: dictionary of headers to send.
@@ -381,10 +383,8 @@ class PreparedRequest(RequestEncodingMixin, RequestHooksMixin):
 
 
 class Response(object):
-    """The core :class:`Response <Response>` object. All
-    :class:`Request <Request>` objects contain a
-    :class:`response <Response>` attribute, which is an instance
-    of this class.
+    """The :class:`Response <Response>` object, which contains a
+    server's response to an HTTP request.
     """
 
     def __init__(self):