Update linkcheck_rate_limit_timeout docs using seconds instead of minutes #12225
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
noklam
changed the title
noklam
changed the title
picnixz
reviewed
Apr 4, 2024
|
Err... that's a good catch. But we should maybe make it clear that the unit is in seconds. |
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
picnixz
approved these changes
Apr 5, 2024
|
Thank you! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject:
Feature or Bugfix
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_rate_limit_timeout
The docs here states that the default is 5 minutes. I checked the class itself doesn't have docstring about the unit. I am not sure exactly why or it's a convention.
I have run into a CI issues that timeout, after changing the configuration a few times and look into the source code. I found out the unit of the configuration is seconds instead of minutes.
kedro-org/kedro#3769
Purpose
To make this clear the units of the configuration is seconds instead of minute.
I can also update change in code when appropriate but please let me know where should the change goes in.