better api docs
authorKenneth Reitz <me@kennethreitz.com>
Thu, 10 Nov 2011 01:15:44 +0000 (17:15 -0800)
committerKenneth Reitz <me@kennethreitz.com>
Thu, 10 Nov 2011 01:15:44 +0000 (17:15 -0800)
docs/api.rst

index 9b1b10f2ea6f1b391aec75365830691e13032490..adbd53f7189284fc4fa02e0da8b5c9f4a897d203 100644 (file)
@@ -17,6 +17,15 @@ All of Request's functionality can be accessed by these 7 methods.
 They all return an instance of the :class:`Response <Response>` object.
 
 .. autofunction:: request
+
+---------------------
+
+
+.. autoclass:: Response
+   :inherited-members:
+
+---------------------
+
 .. autofunction:: head
 .. autofunction:: get
 .. autofunction:: post
@@ -25,11 +34,31 @@ They all return an instance of the :class:`Response <Response>` object.
 .. autofunction:: delete
 
 
------------
+-----------------
+
+.. autofunction:: session
+
+
+
+Exceptions
+~~~~~~~~~~
+
+.. module:: requests
+
+.. autoexception:: RequestException
+.. autoexception:: ConnectionError
+.. autoexception:: HTTPError
+.. autoexception:: URLRequired
+.. autoexception:: TooManyRedirects
+
+
+
+Configurations
+--------------
+
+.. automodule:: requests.defaults
 
 
-.. autoclass:: Response
-   :inherited-members:
 
 Async
 -----
@@ -56,6 +85,22 @@ Requests.
 
 .. module:: requests.utils
 
+Status Code Lookup
+~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: requests.codes
+
+::
+
+    >>> requests.codes['temporary_redirect']
+    301
+
+    >>> requests.codes.teapot
+    416
+
+    >>> requests.codes['\o/']
+    416
+
 Cookies
 ~~~~~~~
 
@@ -80,26 +125,16 @@ These items are an internal component to Requests, and should never be
 seen by the end user (developer). This part of the API documentation
 exists for those who are extending the functionality of Requests.
 
-Exceptions
-~~~~~~~~~~
-
-.. module:: requests
-
-.. autoexception:: HTTPError
-
-.. autoexception:: RequestException
-
-.. autoexception:: AuthenticationError
-.. autoexception:: URLRequired
-.. autoexception:: InvalidMethod
-.. autoexception:: TooManyRedirects
-
-
 
 Classes
 ~~~~~~~
 
+.. autoclass:: requests.Response
+   :inherited-members:
+
 .. autoclass:: requests.Request
    :inherited-members:
 
+.. autoclass:: requests.Session
+   :inherited-members: