Better cookie docs on sessions.
authorCory Benfield <lukasaoz@gmail.com>
Wed, 24 Jul 2013 12:25:59 +0000 (13:25 +0100)
committerCory Benfield <lukasaoz@gmail.com>
Wed, 24 Jul 2013 12:25:59 +0000 (13:25 +0100)
requests/sessions.py

index c24ed5a..e7c3433 100644 (file)
@@ -211,7 +211,10 @@ class Session(SessionRedirectMixin):
         #: Should we trust the environment?
         self.trust_env = True
 
-        # Set up a CookieJar to be used by default
+        #: A CookieJar containing all currently outstanding cookies set on this
+        #: session. By default is a
+        #: :class:`RequestsCookieJar <requests.cookies.RequestsCookieJar>`, but
+        #: may be any other ``CookieJar``.
         self.cookies = cookiejar_from_dict({})
 
         # Default connection adapters.