Skip to content

Commit 17a84a6

Browse files
authored
[doc] clarify units for linkcheck_rate_limit_timeout (sphinx-doc#12225)
Co-authored-by: Bénédikt Tran <[email protected]> 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).
1 parent 4b7a2c3 commit 17a84a6

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/usage/configuration.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2939,7 +2939,8 @@ Options for the linkcheck builder
29392939

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

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

0 commit comments

Comments
 (0)