Skip to content

Commit

Permalink
[doc] clarify units for linkcheck_rate_limit_timeout (#12225)
Browse files Browse the repository at this point in the history
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

This normalizes the description of the configuration value so that its default value's unit is the same as the internal one (i.e., seconds).
  • Loading branch information
noklam committed Apr 5, 2024
1 parent 4b7a2c3 commit 17a84a6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/usage/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2939,7 +2939,8 @@ Options for the linkcheck builder

Otherwise, ``linkcheck`` waits for a minute before to retry and keeps
doubling the wait time between attempts until it succeeds or exceeds the
``linkcheck_rate_limit_timeout``. By default, the timeout is 5 minutes.
``linkcheck_rate_limit_timeout``. By default, the timeout is 300 seconds
and custom timeouts should be given in seconds.

.. _Retry-After: https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.3

Expand Down

0 comments on commit 17a84a6

Please sign in to comment.