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

docs update
---

diff --git a/docs/api.rst b/docs/api.rst
index 3375f28..e7db1dd 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -18,16 +18,6 @@ They all return an instance of the :class:`Response <Response>` object.
 
 .. autofunction:: request
 
----------------------
-
-.. autoclass:: requests.Request
-   :inherited-members:
-
-.. autoclass:: Response
-   :inherited-members:
-
----------------------
-
 .. autofunction:: head
 .. autofunction:: get
 .. autofunction:: post
@@ -36,9 +26,17 @@ They all return an instance of the :class:`Response <Response>` object.
 .. autofunction:: delete
 
 
------------------
+Lower-Level Classes
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: requests.Request
+   :inherited-members:
+
+.. autoclass:: Response
+   :inherited-members:
 
-.. autofunction:: session
+Sessions
+--------
 
 .. autoclass:: Session
    :inherited-members:
diff --git a/requests/models.py b/requests/models.py
index ecd4339..2ec3373 100644
--- a/requests/models.py
+++ b/requests/models.py
@@ -157,6 +157,14 @@ class Request(RequestHooksMixin):
     :param auth: Auth handler or (user, pass) tuple.
     :param cookies: dictionary or CookieJar of cookies to attach to this request.
     :param hooks: dictionary of callback hooks, for internal usage.
+
+    Usage::
+
+      >>> import requests
+      >>> req = requests.Request('GET', 'http://httpbin.org/get')
+      >>> req.prepare()
+      <PreparedRequest [GET]>
+
     """
     def __init__(self,
         method=None,
@@ -214,7 +222,19 @@ class PreparedRequest(RequestEncodingMixin, RequestHooksMixin):
     """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.
+    Generated from either a :class:`Request <Request>` object or manually.
+
+    Usage::
+
+      >>> import requests
+      >>> req = requests.Request('GET', 'http://httpbin.org/get')
+      >>> r = req.prepare()
+      <PreparedRequest [GET]>
+
+      >>> s = requests.Session()
+      >>> s.send(r)
+      <Response [200]>
+
     """
 
     def __init__(self):
diff --git a/requests/sessions.py b/requests/sessions.py
index 982e96f..bc41f8b 100644
--- a/requests/sessions.py
+++ b/requests/sessions.py
@@ -131,7 +131,17 @@ class SessionRedirectMixin(object):
 
 
 class Session(SessionRedirectMixin):
-    """A Requests session."""
+    """A Requests session.
+
+    Provides cookie persistience, connection-pooling, and configuration.
+
+    Basic Usage::
+
+      >>> import requests
+      >>> s = requests.Session()
+      >>> s.get('http://httpbin.org/get')
+      200
+    """
 
     def __init__(self):
 
@@ -140,7 +150,7 @@ class Session(SessionRedirectMixin):
         #: :class:`Session <Session>`.
         self.headers = default_headers()
 
-        #: Authentication tuple or object to attach to
+        #: Default Authentication tuple or object to attach to
         #: :class:`Request <Request>`.
         self.auth = None
 
@@ -157,19 +167,19 @@ class Session(SessionRedirectMixin):
         #: representing multivalued query parameters.
         self.params = {}
 
-        #: Stream response content.
+        #: Stream response content default.
         self.stream = False
 
-        #: SSL Verification.
+        #: SSL Verification default.
         self.verify = True
 
-        #: SSL certificate.
+        #: SSL certificate default.
         self.cert = None
 
         #: Maximum number of redirects to follow.
         self.max_redirects = DEFAULT_REDIRECT_LIMIT
 
-        #: Should we trust the environment
+        #: Should we trust the environment?
         self.trust_env = True
 
         # Set up a CookieJar to be used by default