fix(docs): resource_poll_interval's doc comment claims the wrong default - #1593
Open
CaptainVirgil wants to merge 1 commit into
Open
fix(docs): resource_poll_interval's doc comment claims the wrong default#1593CaptainVirgil wants to merge 1 commit into
CaptainVirgil wants to merge 1 commit into
Conversation
default_poll_interval() returns Timelength::OneHour, but the field's doc comment says "Default: 5-min." Anyone relying on the doc comment (rather than reading default_poll_interval() itself) will build monitoring or automation around a poll cadence 12x faster than what actually runs, and see gaps of up to an hour with no corresponding log output as unexplained. Corrects the comment to match the code. Not touching the default value itself, since that's a behavior decision and this is just a doc fix.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
resource_poll_interval's doc comment says "Default:5-min.", butdefault_poll_interval()(in the same file) actually returnsTimelength::OneHour. The two have disagreed since the field was introduced.Anyone relying on the doc comment rather than reading
default_poll_interval()directly will assume resources are polled 12x more often than they actually are, and could misread a genuinely-normal gap of up to an hour (with no corresponding log output, since the refresh loop only logs on failure) as a stuck/wedged sync.What changed
One line: the doc comment now says
Default: 1-hr., matching the actual code. Not touching the default value itself — that's a behavior decision for the maintainers, this is just correcting the documentation to match what already ships.Test plan