b0ad2499c8
Prefer https:// for URLs throughout project
2018-09-30 17:14:40 -05:00
5aa6a9b654
In docs, use intersphinx to link to Python documentation
...
The intersphinx extension can generate automatic links to the
documentation of objects in other projects. It was already used for
urllib3. For complete details on intersphinx, see:
http://www.sphinx-doc.org/en/master/ext/intersphinx.html
2018-08-11 17:31:43 -07:00
9c92f757e6
Rolled multi-value form examples in documentation into one ( #4700 )
...
As suggested by @nateprewitt
2018-07-20 10:30:31 +03:00
9a8eb131c9
Documentation for multivalued form-encoded element as a list ( #4700 )
2018-07-20 10:30:31 +03:00
35a1874912
Update Python 2 doc links to Python 3
...
The Python 3 docs are better maintained and are the future of Python
development.
2018-06-09 20:29:41 -07:00
35af0b077f
add comment about json parameter changing content-type
2018-03-16 12:34:24 -07:00
265ef609d5
Remove remaining references to removed, vendored packages ( #4499 )
...
As the vendored packages were removing in version 2.16, all remaining
doc references should be replaced with newer practices.
2018-02-17 08:15:54 -06:00
39446def39
Clarify behaviour of json parameter.
...
`json` is ignored if `data` or `files` is not empty.
2017-11-21 13:40:59 +00:00
7cc3d8dc6a
docs/quickstart: clarify raw response reading.
2017-11-17 16:37:08 -05:00
7f08ad3b6c
Corrent HTTP -> HTML in quickstart doc
2017-11-16 09:59:00 +02:00
kennethreitz
8af65a1eca
Update quickstart.rst
2017-09-04 16:09:51 -04:00
kennethreitz
b9a004a22b
improvements
2017-05-27 17:25:44 -04:00
21972c4601
fix #3902 Add proposed documentation change for post data
2017-03-01 13:04:11 -06:00
08ce652b8b
Say that we use a dictionary of strings.
2017-02-08 11:54:32 +00:00
4f9d0e0455
streaming doc clarification
2016-11-21 14:17:28 -07:00
ed3ba3dbb8
correct backtick formatting
2016-11-17 12:26:19 -05:00
5562c0f097
clarify that the chunk_size is optional when streaming to a file
2016-11-17 12:21:58 -05:00
b4d843bad2
Fixed readme typo - 'site' should be 'domain'
2016-11-15 22:27:45 -05:00
cfb7fd8f28
Amplifies the timeout warning in the docs.
...
Partially addresses #3070 .
2016-11-14 09:57:08 -08:00
b5fac31688
Changes to documentation based on comments and correction of list of authors.
2016-08-17 22:03:18 +02:00
b26606cc3c
Adding notes about Request's timeout behavior.
2016-08-17 20:27:00 +02:00
1435cf5aff
docs updates
2016-08-14 20:56:52 -06:00
00f83fb0c6
fix grammer mistakes in Quickstart
2016-08-13 10:19:10 +08:00
07b7872df8
Add a bit about RequestsCookieJar to Cookies section
2016-08-03 13:03:34 -07:00
cf938420f8
in python3.x not have StringIO
...
I think, should such an amendment.
2016-07-14 10:40:32 +08:00
1cb3b797fe
updating documentation to reflect decision of #3386
2016-07-07 07:44:20 -06:00
277d4a41ad
Note how HTTPErrors are raised
2016-06-08 18:19:10 -07:00
70a344d8eb
Update readthedocs links.
2016-04-28 12:39:10 +02:00
kennethreitz
bf8c8312dd
cleanup quickstart
2016-02-19 02:12:15 -05:00
0d25f8a00c
Fixed markup for/rendering of list in section "Custom Headers".
2016-01-30 14:45:07 +01:00
fcb8c8d33b
Docs: clarify the precedence of auth= over netrc
...
This closes #2062 by clarifying in the docs which auth
header takes precedence:
1st auth=
2nd .netrc
3rd headers=
This precedence order is already tested in test_requests.py,
in the test_basicauth_with_netrc method. Perhaps we should
add further tests for non-basic auth schemes.
2015-12-21 11:52:45 -05:00
de2a5f4332
Remove redundant json import.
2015-11-12 16:54:47 +03:00
d290a9b4c6
Merge pull request #2825 from Lukasa/universal_newlines
...
Add warnings about text/binary mode files.
2015-10-24 09:37:16 -05:00
b675377dc2
added fix for #2826
2015-10-16 17:01:36 +05:30
7c55446b7e
Add warnings about text/binary mode files.
2015-10-14 13:23:19 +01:00
139418475c
Remove reference to ok.
2015-10-03 18:33:25 +01:00
443d07e0d3
Fix #2799 : Update Quickstart documentation of Response.json()
2015-10-03 00:01:58 +01:00
f4eaefa63e
fix rfc quotation
2015-09-05 12:07:49 +02:00
7197afa887
Fixed minor rendering issue in documentation code blocks
2015-08-15 21:56:24 +02:00
98a59e4894
Merge pull request #2724 from smiley/master
...
Add documentation in "More complicated POST requests" (Quickstart) to resolve #2686
2015-08-14 15:30:00 -04:00
b1de7e7287
Changed phrasing to be a little clearer.
2015-08-14 17:31:54 +03:00
5a9097dc4b
Update quickstart.rst
...
Added note about the `json` parameter in `requests.post`.
2015-08-14 17:15:51 +03:00
6648defcdd
Fix docs for passing a list of values for a query string
...
The special `[]` notation at the end of the field name is not necessary to get a field to appear with multiple values in the query string.
2015-07-18 18:50:29 -04:00
beaa7e4180
Fix quickstart "Custom Headers" example intro
...
Previously this section prefaced an example with:
For example, we didn't specify our content-type
But, the actual example set a custom user-agent header on the request. This
changes it to say "user-agent" instead which matches the given example.
2015-07-15 23:31:21 +01:00
1b1866934b
updated custom header precedence info with .netrc example
2015-04-05 14:23:10 -07:00
898465756a
added custom header precedence info
2015-04-03 07:58:42 -07:00
3711e04f37
edited the useragent string
2015-03-15 22:42:43 +05:00
6e2f1eb402
made the quickstart more reader friendly. Closes #2418
2015-03-15 01:02:09 +05:00
ed73d9e45d
document combination of repeated response headers
2015-02-20 12:20:18 -06:00
291b6b24b7
Update to use readthedocs.org instead of rtfd.org
...
https://toolbelt.rtfd.org causes an SSL error because the wildcard SSL cert is for *.readthedocs.org.
2015-02-06 13:46:38 +00:00
Jon Dufresne
kennethreitz