Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix broken links in docs #6583

Merged
merged 6 commits into from
Feb 23, 2024
Merged

Fix broken links in docs #6583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0ec2780
update broken github pagination link
EFord36 Nov 24, 2023
d3b3399
update authors github link
EFord36 Nov 24, 2023
541aa80
update urllib3 docs link
EFord36 Nov 24, 2023
5f1c3c2
remove section with broken link to survey
EFord36 Nov 24, 2023
0a7f662
Make example URL format a literal rather than an actual link
EFord36 Nov 24, 2023
a0e79ba
update broken rfc link
EFord36 Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Keepers of the Crystals

Previous Keepers of Crystals
````````````````````````````
- Kenneth Reitz <me@kennethreitz.org> `@ken-reitz <https://github.com/ken-reitz>`_, reluctant Keeper of the Master Crystal.
- Kenneth Reitz <me@kennethreitz.org> `@kennethreitz <https://github.com/kennethreitz>`_, reluctant Keeper of the Master Crystal.
- Cory Benfield <cory@lukasa.co.uk> `@lukasa <https://github.com/lukasa>`_
- Ian Cordasco <graffatcolmingov@gmail.com> `@sigmavirus24 <https://github.com/sigmavirus24>`_.

Expand Down
2 changes: 1 addition & 1 deletion HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/user/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 <https://developer.github.com/v3/#pagination>`_
GitHub uses these for `pagination <https://docs.github.com/en/rest/guides/using-pagination-in-the-rest-api>`_
in their API, for example::

>>> url = 'https://api.github.com/users/kennethreitz/repos?page=1&per_page=10'
Expand Down Expand Up @@ -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 <https://www.hjp.at/doc/rfc/rfc2988.txt>`_.
retransmission window <https://datatracker.ietf.org/doc/html/rfc2988>`_.
Copy link

@Jamim Jamim Jan 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Despite the fact I already approved this PR, there's still a room for improvement.
RFC 2988 was obsoleted by RFC 6298, so this link might be updated even further, but it would require additional changes since newer RFC makes the whole statement not correct due to this change.
So this might be handled in an additional PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - seems like a sensible comment, agree it makes sense for an additional PR.


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
Expand Down
3 changes: 0 additions & 3 deletions docs/user/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,3 @@ All exceptions that Requests explicitly raises inherit from
-----------------------

Ready for more? Check out the :ref:`advanced <advanced>` section.


If you're on the job market, consider taking `this programming quiz <https://triplebyte.com/a/b1i2FB8/requests-docs-1>`_. A substantial donation will be made to this project, if you find a job through this platform.
Loading