summaryrefslogtreecommitdiff
path: root/docs/api.rst
Commit message (Collapse)AuthorAgeFilesLines
* Remove remaining references to removed, vendored packages (#4499)Jon Dufresne2018-02-171-1/+1
| | | | As the vendored packages were removing in version 2.16, all remaining doc references should be replaced with newer practices.
* Add documentation for available status codesZane Bitter2017-11-211-11/+1
| | | | | | | | | | | | | | | | | | | | | | | | | There was no way to determine what actual names were available outside of looking at the source code. They were not listed in the documentation or accessible through the interactive help. In addition, doing `pydoc requests.status_codes` displayed some pretty unhelpful information - the utf-8 encoding string was included in the module name, there was no description, and internal variables used for initialisation leaked into the module scope: DATA code = 511 codes = <lookup 'status_codes'> title = 'network_authentication' titles = ('network_authentication_required', 'network_auth', ... This change prevents the internal variables from leaking, adds a docstring (which has the side-effect of correcting the module name), and appends information on the allowed status code names to the docstring when the module is initialised. The improved module documentation is then used in the API documentation to provide another easy reference to the complete list of status codes.
* correct module for cookiejar_from_dict in docsNate Prewitt2016-11-021-1/+1
|
* docs updatesNate Prewitt2016-08-141-0/+3
|
* updating documentation to reflect decision of #3386Nate Prewitt2016-07-071-1/+5
|
* Fix autofunction ReferenceBrandon Sandrowicz2016-03-081-1/+1
| | | `request.codes` is a class (`LookupDict`), not a function.
* refactor API documentationKenneth Reitz2016-02-181-49/+42
|
* Update example for Python 2/3 compatible.shoma2016-01-221-3/+5
|
* Fix api doc of debug logging for Python 3shoma2016-01-221-3/+4
|
* Docs: Clarify that method-level params are not persisted in sessions.Lukas Graf2015-08-081-0/+2
|
* Clean up cookie docs and display them.Cory Benfield2014-12-241-0/+6
|
* tildesKevin Burke2014-08-291-1/+1
|
* s/behavior/behaviourKevin Burke2014-08-291-1/+1
|
* Document Timeout behaviourKevin Burke2014-08-291-18/+2
|
* Add support for connect timeoutsKevin Burke2014-08-231-1/+1
| | | | | | | Modifies the timeout interface to also accept a tuple (connect, read) which would be used to set individual connect and read timeouts for Requests. Adds Advanced documentation explaining the interface and providing guidance for timeout values.
* Add authentication classes to the API documentDavid Pursehouse2014-07-181-0/+7
| | | | Change-Id: Ic1464f246602b809f3c29fbafd6f36b747d5d5df
* Add Timeout exception in API documentationDavid Pursehouse2014-07-151-0/+1
| | | | | | | The Timeout exception is referenced from quickstart.rst but does not get hyperlinked. Change-Id: I69ad881bf9d2475c6239ac7b17f68ddbce0d03cd
* Timeout documentation changes.Cory Benfield2014-03-031-1/+3
|
* Added link to @Lukasa's blog - the source materialDavid Fischer2013-09-241-0/+6
|
* Added migrating to 2.x docsDavid Fischer2013-09-241-0/+64
|
* clearly describe `r.raw` in Body Content Workflowhomm2013-09-121-1/+1
|
* remove extra mention of dangerous `r.raw`homm2013-09-121-4/+5
|
* Some cosmetic updates to the docsKwpolska2013-07-201-1/+1
| | | | Signed-off-by: Kwpolska <kwpolska@gmail.com>
* Fix API documentation issuesamercader2013-04-301-14/+11
| | | | | | | | * 'Cookies' and 'Encodings' sections were not built because the reference to the functions was wrong. * 'Exceptions' section had a wrong anchor link ('module-requests', same one as the main heading). * Remove 'decode_gzip' function, which is no longer present.
* A tiny typo, noticed while working on the Polish translation.Chris Warrick2013-04-271-1/+1
|
* Updated documentation indicating that logging is done via ↵Sorin Sbarnea2013-04-101-1/+1
| | | | | | requests.packages.urllib3 instead of requests. modified: docs/api.rst
* * Documented the logging, requested in #1297Sorin Sbarnea2013-04-101-3/+17
| | | | | | | | | * Added build directory and *.egg to .gitignore * Added sphinx as setup requirement in order to be able to build documentation with `pyhton setup.py build_sphinx` modified: .gitignore modified: docs/api.rst modified: setup.py
* Add HTTPAdapter to API docs.Cory Benfield2013-04-091-0/+6
|
* Session isn't advertised as a context managerDavid Fischer2013-03-021-3/+4
|
* Capitalize s in SessionDavid Fischer2013-03-021-1/+1
|
* Logic on streaming responses was changed in 1.0David Fischer2013-03-021-3/+3
| | | | * prefetch=False in 0.x is now stream=True
* Initial docs patch for migrating from pre 1.0David Fischer2013-03-011-0/+70
|
* developer interfaceKenneth Reitz2012-12-231-2/+2
|
* request sessionsKenneth Reitz2012-12-231-11/+2
|
* cleaup api docsKenneth Reitz2012-12-231-16/+0
|
* docs updateKenneth Reitz2012-12-231-12/+10
|
* requestKenneth Reitz2012-12-231-0/+2
|
* no async anymoreKenneth Reitz2012-12-231-19/+3
|
* Update documentation on Sessions.Cory Benfield2012-11-171-0/+3
| | | | | This resolves issue #870. Better documentation here should be considered for further work.
* Fixing status codes. Somehow these were wrong.Peter Manser2011-11-141-3/+3
|
* refKenneth Reitz2011-11-091-0/+2
|
* better stepping for elastic designKenneth Reitz2011-11-091-0/+2
|
* better api docsKenneth Reitz2011-11-091-18/+53
|
* Async APIKenneth Reitz2011-10-131-3/+15
|
* Migrate new docs over.Kenneth Reitz2011-10-131-12/+48
|
* doc cleanupsKenneth Reitz2011-08-171-12/+1
|
* :+1:Kenneth Reitz2011-07-091-1/+1
|
* add PATCH to docsKenneth Reitz2011-06-211-1/+3
|
* api updateKenneth Reitz2011-05-161-0/+6
|
* Big API updateKenneth Reitz2011-05-161-1/+47
|
View Lorry Controller Status