From: Kenneth Reitz <me@kennethreitz.com>
Date: Wed, 17 Aug 2011 06:49:13 +0000 (-0400)
Subject: docs update
X-Git-Tag: v0.6.0~16
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=abcf81e2a8cd5497080fad7fb4ac6b6a87eacd6c;p=services%2Fpython-requests.git

docs update
---

diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst
index 066ebde..97687b2 100644
--- a/docs/user/advanced.rst
+++ b/docs/user/advanced.rst
@@ -3,20 +3,46 @@
 Advanced Usage
 ==============
 
-This document covers more advanced features.
+This document covers some of Requests more advanced features.
+
 
 Session Objects
-===============
+---------------
+
+The Session object allows you to persist certain parameters across
+requests. It also establishes a CookieJar and passes it along
+to any requests made from the Session instance.
+
+A session object has all the methods of the main Requests API.
+
+Let's persist some cookies across requests::
+
+    with requests.session() as s:
+
+        s.get('http://httpbin.org/cookies/set/sessioncookie/123456789')
+        r = s.get("http://httpbin.org/cookies")
+
+        print r.content
+
+
+Sessions can also be used to provide default data to the request methods::
+
+    headers = {'x-test': 'true'}
+    auth = ('user', 'pass')
+
+    with requests.session(auth=auth, headers=headers) as c:
+
+        # both 'x-test' and 'x-test2' are sent
+        c.get('http://httpbin.org/headers', header={'x-test2', 'true'})
+
 
-.. module:: requests.session 
+.. admonition:: Global Settings
 
-The Session object allows you to persist certain parameters across requests.  It also establishes a CookieJar by default and passes it along in any requests made from the Session instance.  For a complete list of allowed parameters, please see the *__attrs__* field in *requests/session.py*. ::
+    Certain parameters are best set at the ``request.config`` level
+    (e.g.. a global proxy, user agent header).
 
-    from requests.session import Session
 
-    s = Session()
-    s.get("http://httpbin.org/cookies/set/sessioncookie/123456789")
-    r = s.get("http://httpbin.org/cookies")
-    print r.content
+Event Hooks
+-----------
 
-Note: Certain parameters are best set at the request.config level (i.e. a global proxy, user agent header).
+Requests has a hook system that allows you . This is useful for
\ No newline at end of file