From 0ec2780c291107b6686996e4b38f3d63e076eda7 Mon Sep 17 00:00:00 2001 From: Elliot Ford Date: Fri, 24 Nov 2023 10:37:33 +0000 Subject: [PATCH 1/6] update broken github pagination link --- docs/user/advanced.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst index ecd17cb300..a61aa85074 100644 --- a/docs/user/advanced.rst +++ b/docs/user/advanced.rst @@ -948,7 +948,7 @@ Link Headers Many HTTP APIs feature Link headers. They make APIs more self describing and discoverable. -GitHub uses these for `pagination `_ +GitHub uses these for `pagination `_ in their API, for example:: >>> url = 'https://api.github.com/users/kennethreitz/repos?page=1&per_page=10' From d3b3399ece1f76387d323983638e0838c06e88ea Mon Sep 17 00:00:00 2001 From: Elliot Ford Date: Fri, 24 Nov 2023 10:44:09 +0000 Subject: [PATCH 2/6] update authors github link Update account link for original author which has changed. --- AUTHORS.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 1dc04117cf..6e017c9a91 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -8,7 +8,7 @@ Keepers of the Crystals Previous Keepers of Crystals ```````````````````````````` -- Kenneth Reitz `@ken-reitz `_, reluctant Keeper of the Master Crystal. +- Kenneth Reitz `@kennethreitz `_, reluctant Keeper of the Master Crystal. - Cory Benfield `@lukasa `_ - Ian Cordasco `@sigmavirus24 `_. From 541aa80ca3d0ee771611bd155a5172efaa26d9da Mon Sep 17 00:00:00 2001 From: Elliot Ford Date: Fri, 24 Nov 2023 11:04:16 +0000 Subject: [PATCH 3/6] update urllib3 docs link --- docs/user/advanced.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst index a61aa85074..037e50a4fc 100644 --- a/docs/user/advanced.rst +++ b/docs/user/advanced.rst @@ -291,7 +291,7 @@ versions of Requests. For the sake of security we recommend upgrading certifi frequently! .. _HTTP persistent connection: https://en.wikipedia.org/wiki/HTTP_persistent_connection -.. _connection pooling: https://urllib3.readthedocs.io/en/latest/reference/index.html#module-urllib3.connectionpool +.. _connection pooling: https://urllib3.readthedocs.io/en/latest/reference/urllib3.connectionpool.html .. _certifi: https://certifiio.readthedocs.io/ .. _Mozilla trust store: https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt From 5f1c3c22ff7c7bb89a4e017e3f336cbc88e189c3 Mon Sep 17 00:00:00 2001 From: Elliot Ford Date: Fri, 24 Nov 2023 11:04:32 +0000 Subject: [PATCH 4/6] remove section with broken link to survey --- docs/user/quickstart.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index bbf3745eea..33c2732c7f 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -568,6 +568,3 @@ All exceptions that Requests explicitly raises inherit from ----------------------- Ready for more? Check out the :ref:`advanced ` section. - - -If you're on the job market, consider taking `this programming quiz `_. A substantial donation will be made to this project, if you find a job through this platform. From 0a7f662aa70d39b6c3b5c804be00af5731292550 Mon Sep 17 00:00:00 2001 From: Elliot Ford Date: Fri, 24 Nov 2023 11:04:54 +0000 Subject: [PATCH 5/6] Make example URL format a literal rather than an actual link The rendered docs 'auto-link' this, which might encourage users to click the link, even though it doesn't go anywhere. --- HISTORY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index bbe6dd425b..432ee3b174 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -14,7 +14,7 @@ dev forwarding of `Proxy-Authorization` headers to destination servers when following HTTPS redirects. - When proxies are defined with user info (https://user:pass@proxy:8080), Requests + When proxies are defined with user info (`https://user:pass@proxy:8080`), Requests will construct a `Proxy-Authorization` header that is attached to the request to authenticate with the proxy. From a0e79bad059f2d0e6d3c00a2a7311acb2bef4d67 Mon Sep 17 00:00:00 2001 From: Elliot Ford Date: Fri, 24 Nov 2023 11:05:45 +0000 Subject: [PATCH 6/6] update broken rfc link ietf seems appropriate here - it's used elsewhere in the requets docs in several places. --- docs/user/advanced.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst index 037e50a4fc..ff3a3d0f26 100644 --- a/docs/user/advanced.rst +++ b/docs/user/advanced.rst @@ -1099,7 +1099,7 @@ The **connect** timeout is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the `connect()`_) call on the socket. It's a good practice to set connect timeouts to slightly larger than a multiple of 3, which is the default `TCP packet -retransmission window `_. +retransmission window `_. Once your client has connected to the server and sent the HTTP request, the **read** timeout is the number of seconds the client will wait for the server