Commit Graph

87 Commits

Author SHA1 Message Date
Yang Zhang 2cb523b267 Fix typo in Timeouts doc 2013-09-07 00:16:09 -07:00
Yang Zhang 6d0315f78f Clarify timeout behavior in quickstart doc 2013-09-06 19:27:57 -07:00
enkore 4ffc3e4d1f Remove superfluous double dot 2013-08-18 03:06:34 +02:00
Kwpolska 587385bfe0 Grammar fixes and such
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 12:56:25 +02:00
Kwpolska ca033b83fe Some cosmetic updates to the docs
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 12:12:57 +02:00
Cory Benfield 8385fb397b Remove charset from JSON types: not valid. 2013-07-19 14:03:20 +01:00
s7v7nislands 39ad5e7388 merge 2013-07-19 17:12:01 +08:00
s7v7nislands 0df505bd7c fix doc 2013-07-19 17:04:53 +08:00
David Pursehouse 07ad75ee04 Fix #1322: Add note in docs about None not being sent as data
In the case:

  payload = {'key1': 'value1', 'key2': 'value2', 'key3': None}
  r = requests.get("http://httpbin.org", params=payload)

the parameter `key3` will not be sent as a parameter in the URL.

Mention this in the documentation.
2013-07-19 17:14:59 +09:00
Kevin Burke a6415cf895 Link to the actual exception references
Sphinx has a neat cross-referencing feature where if you include the tilde
character in front of a :py: class, it'll link to the full object but provide
only the last part of class name in the text. For more info see
http://sphinx-doc.org/domains.html#cross-referencing-syntax
2013-06-12 15:53:09 -07:00
Julien Bouquillon 340931ba8e Update quickstart.rst
rephrase misleading info about `raise_for_status`
2013-05-29 12:57:49 +03:00
Sasha Laundy 8ebeb3dc3f Make json error message more specific 2013-04-08 13:03:13 -04:00
sursh dfa59c2d97 Fix markdown 2013-04-08 13:01:02 -03:00
sursh 511cc4c034 Make json error on empty response more specific 2013-04-08 13:00:27 -03:00
Markus Wiik 90e109c241 Fix issue #1225 (Documentation: response object status/reason) 2013-03-05 16:18:24 +01:00
David Fischer 38f2581d6f Github URL fix 2013-03-01 20:36:42 -08:00
Cory Benfield d3e6597f73 Update docs with correct cookie behaviour. 2013-01-17 19:28:28 +00:00
Ian Cordasco fef09a6691 Remove safe_mode/danger_mode from docs 2012-12-30 19:46:04 -05:00
Kenneth Reitz f1d51aa7eb timeout 2012-12-23 02:45:41 -05:00
Kenneth Reitz 5b5ff69201 update docs 2012-12-23 02:42:14 -05:00
Kenneth Reitz 4701243199 Merge pull request #1009 from Lukasa/master
Auth documentation.
2012-12-17 11:27:36 -08:00
Cory Benfield a7c5d5e8ac Split authentication out into a separate file. 2012-12-17 19:25:21 +00:00
Kamil Kisiel fe0b0a989f Fixed a few spots in the docs that were still using json as a property. 2012-12-17 11:02:06 -08:00
Cory Benfield 54b77afbb5 Uh, typo broke the link. Yeah. That happened. 2012-12-17 18:31:56 +00:00
Cory Benfield be364e13d3 Update auth documentation with org info. 2012-12-17 18:31:56 +00:00
Kenneth Reitz 1451ba0c6d update docs 2012-12-17 08:33:18 -05:00
Cory Benfield 93b2be48f0 Prefetch must be false to use response.raw.
Resolves issue #979.
2012-12-04 18:10:33 +00:00
Kenneth Reitz 9840966d72 typo all the things 2012-10-13 00:46:46 +01:00
Kenneth Reitz f33a0aa47b oauth awesomeness 2012-10-13 00:45:05 +01:00
Kenneth Reitz cb0fdd80d0 Merge pull request #784 from Locker537/docs_fix
Change variable '_r' to 'r' for consistency.
2012-08-17 13:59:29 -07:00
Kay Zhu 76f90054f9 "There many ..." to "There are many ..." in quickstart 2012-08-17 06:12:15 -04:00
Locker537 b31a4399c7 Remove trailing whitespace from docs directory. 2012-08-16 17:08:57 -04:00
Locker537 b9d3ce2e10 Change variable '_r' to 'bad_r' to avoid confusion about Python's private variable convention. 2012-08-16 16:50:01 -04:00
Locker537 ff55d737d5 Change variable '_r' to 'r' for consistency. 2012-08-16 16:27:31 -04:00
Cory Benfield 7a9419ce35 Document encodings and RFC compliance. 2012-08-10 14:47:13 +01:00
anentropic fdec88de99 example looked wrong
From what I can tell from the source code (down thru urllib3) the key in the `files` dict is always the 'fieldname', while specifying a custom filename is optional.

So in this example it is confusing to have a fieldname of 'report.xls' (the filename) where all the other examples use a fieldname of 'file'.
2012-08-02 13:56:12 +02:00
karl 9fe4a99365 adding clarification to the history API. It was not clear how the history list was sorted. 2012-07-12 16:34:28 -04:00
Ian Cordasco 3aa7f24e74 Fix Response Status Codes in the docs. 2012-06-21 15:06:01 -04:00
jkleint 234a55da6a Update raise_for_status() exception output to reflect that requests.exceptions.HTTPError is raised, not urllib2.HTTPError. 2012-06-18 17:26:42 -03:00
Danilo Bargen 1164450dac Added r.json documentation (document ALL the awesome features!) 2012-06-06 16:59:20 +02:00
Cory Benfield 36fd8da1c0 Correctly reflect redirection behaviour.
The docs incorrectly listed HEAD as a method that follows redirects by
default: it does not. This commit resolves this issue, and thus resolves
issue #504.
2012-05-17 19:25:35 +01:00
Cory Benfield 45506d1f39 Rewrite quickstart docs.
This should help with issue #503.
2012-05-17 10:16:42 +01:00
barberj e912a6f5da sending strings to be received as files 2012-05-06 15:14:57 -07:00
Shivaram Lingamneni fdd08215ea update documentation to correspond to new cookie API 2012-05-01 21:46:53 -07:00
Jonathan Drosdeck f2172922c5 Add quickstart doc and example for passing parameters in a GET request 2012-03-18 15:37:46 -04:00
Danilo Bargen 8b750ee182 Added StringIO/Image example to quickstart documentation. 2012-02-21 09:24:52 +01:00
Kenneth Reitz 1bc377b188 r.text 2012-01-23 02:42:34 -05:00
Kenneth Reitz a89530aef5 explain binary response data 2012-01-23 02:42:05 -05:00
Bryan Helmig aa39fb0c80 mention of error modes in quickstart 2012-01-05 14:11:19 -06:00
Nick Hatch a6412b02ba Fix spelling errors, typos. 2011-12-11 01:58:55 -06:00