Commit Graph

213 Commits

Author SHA1 Message Date
Kevin Burke a0e7706440 Fix warnings when building the docs
It may be nice to make builds fail if new documentation generates warnings, to
avoid these sorts of problems slipping in in the future.
2013-12-28 00:09:29 -08:00
Cory Benfield 4a6a0c3c65 Update docs to highlight the value of r.encoding. 2013-12-20 09:15:12 +00:00
Ian Cordasco d8d9591076 Update the history and change the last last references to charade 2013-12-18 08:46:49 -06:00
Kenneth Reitz ebdd5cabab further cleanup examples 2013-10-28 13:39:04 -04:00
Kenneth Reitz a9839dc7db Merge remote-tracking branch 'origin/master' 2013-10-28 13:36:08 -04:00
Kenneth Reitz 2c1f51be0e fix @lukasa's lack of taste :)
#1702
2013-10-28 13:36:04 -04:00
Cory Benfield e8683f00a6 Improve the PreparedRequest docs. 2013-10-24 21:14:46 +01:00
Cory Benfield 741fd3ded5 Remove requests.*() from docs.
This looks like a typo, even though it isn't.
2013-10-21 11:57:06 +01:00
Ian Cordasco 6a24eb6d20 Add bit to docs about iter_content 2013-10-20 12:29:43 -05:00
Cory Benfield c8d3dcb315 Small grammar fix. 2013-10-16 22:11:54 +01:00
Qingping Hou 3d0a1eb90d fix doc for redirction and history
In current version of requests, allow_redirect is disabled by default
only for HEAD requests
2013-10-16 16:59:22 -04:00
Randy Morris f32b86dba2 False -> True typo 2013-10-08 14:19:30 -04:00
Randy Morris 66339b21fa update verbiage about streaming requests
The Twitter API is no longer used in the example.
2013-10-07 10:43:48 -04:00
Riyad Parvez 36485983ca fixed print statement 2013-10-05 20:11:30 +06:00
Riyad Parvez 6087015f1c Update advanced.rst 2013-10-05 20:10:27 +06:00
Riyad Parvez 4656c9b89b fixed print statement 2013-10-05 09:57:18 +06:00
Riyad Parvez f9b7d92b91 updated print statement 2013-10-05 09:55:14 +06:00
David Pursehouse 82e6706722 Minor doc updates
- Improve wording of sentence describing proxy environment
  variable setting.
- Mention that proxy URLs must include the scheme.
2013-10-04 10:19:33 +09:00
homm a4cd1a85d6 fix spelling 2013-09-12 13:21:54 +04:00
homm 3440fca2e8 clearly describe r.raw in Body Content Workflow 2013-09-12 13:13:51 +04:00
homm 10b6d77945 remove extra mention of dangerous r.raw 2013-09-12 10:20:47 +04:00
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
libbkmz 78e5262dbd Update advanced.rst 2013-08-19 00:01:37 +04:00
enkore 4ffc3e4d1f Remove superfluous double dot 2013-08-18 03:06:34 +02:00
David Pursehouse 62f0df4434 Add a simple example of custom authentication in the documentation
Refs #1471
2013-07-22 09:14:33 +09:00
David Pursehouse 5cdcf58b3b Wrap long lines in the authentication documentation 2013-07-22 09:08:47 +09:00
Kwpolska 2ef782b8e6 further treatment
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 13:54:33 +02:00
Kwpolska b738c97ec3 session object should be uppercase
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 13:39:50 +02:00
Kwpolska 022c370bcd fixed underline
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 13:31:37 +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 949a29c34f Merge pull request #1470 from Lukasa/carset
Remove charset from JSON types: not valid.
2013-07-19 06:45:56 -07:00
Cory Benfield be884341f4 Merge pull request #1465 from dpursehouse/doc-netrc-authentication
Improve documentation of netrc authentication
2013-07-19 06:45:17 -07:00
David Pursehouse c88fd8cc9d Move netrc authentication documentation under the Basic Auth section 2013-07-19 22:37:57 +09: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 6f6a920a68 Improve documentation of netrc authentication
The documentation does not make it clear that when the credentials
from netrc are used, Requests authenticates with HTTP Basic Auth.

I just spent ages trying to figure out why it wasn't working, and
it was because although the credentials in the netrc were correct,
the server actually required HTTP Digest Auth.

Add a section in the authentication documentation to make it clear
that HTTP Basic Auth is used.
2013-07-19 17:30:54 +09: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
Lukasz Balcerzak 805abee9b4 Fixed wrong method call at streaming example
405 is returned if POST request is performed to http://httpbin.org/stream/20
2013-06-27 13:37:39 +02: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
Josh Schneier 43a64d9515 fix doc typo 2013-06-09 11:14:14 -04:00
Kenneth Reitz cfd84d74ee Merge pull request #1392 from revolunet/patch-2
Update quickstart.rst
2013-06-08 03:16:21 -07:00
Cory Benfield f53aed1611 Document blocking calls. 2013-06-08 11:09:39 +01:00
Julien Bouquillon 340931ba8e Update quickstart.rst
rephrase misleading info about `raise_for_status`
2013-05-29 12:57:49 +03:00
giacomo 8781b56a0e Fixed example in authentication docs 2013-05-02 18:16:19 +03:00
Kenneth Reitz 082029ff2e switch streaming requests to httpbin 2013-04-13 15:26:49 -04:00
Mike Helmick ed0242ae3a Fix Advanced docs Twitter Streaming example
Twitter API v1.1 Streaming now requires OAuth Authentication rather than XAuth.
I believe v1 is being blacked out sometime at the beginning of May.
2013-04-11 20:19:51 -04:00
Cory Benfield e5f1053b30 Shell of Transport Adapter documentation. 2013-04-09 20:58:59 +01:00