summaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.com>2011-05-16 01:18:09 -0400
committerKenneth Reitz <me@kennethreitz.com>2011-05-16 01:18:09 -0400
commit7929bb91be414a798cf6fa386adc7639976c26fd (patch)
tree693ac312bc93a454ba987710e782a678e1eb2be8 /docs/api.rst
parent6e13e7343d2d1a37fe61365c7658984bcf4d9194 (diff)
downloadpython-requests-7929bb91be414a798cf6fa386adc7639976c26fd.tar.gz
api update
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index cabc0e77..9d9bc0a8 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -13,12 +13,18 @@ important right here and provide links to the canonical documentation.
Main Interface
--------------
+All of Request's functionality can be accessed by these 5 methods. They
+all return a :class:`Response <models.Response>` object.
+
.. autofunction:: get
.. autofunction:: post
.. autofunction:: put
.. autofunction:: delete
.. autofunction:: head
+-----------
+
+
.. autoclass:: requests.models.Response
:inherited-members: