docs: correct default PERIOD to 10m to match code#1148
Open
buddhaCode wants to merge 1 commit into
Open
Conversation
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
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.
Problem
The README documents the default
PERIODas5m, but the code uses10m. The documentation and the actual behavior disagree.Code reference (current
master):I checked the history across releases
v2.4.0throughv2.9.0andmaster: the code default has always been10m(it wasparams.Default("10m")before the gosettings rework). So this looks like stale documentation rather than a code regression.Change
This PR only touches the README to align the docs with the code (
5m->10m) at the three relevant spots:PERIODrow in the environment variables table.The
UPDATE_COOLDOWN_PERIODdefault (5m) is left unchanged, since it correctly matchesdefaultCooldown = 5 * time.Minute.No code is modified, so no Go tests are affected.
Alternative
If
5mwas actually the intended default and the code is what's wrong, the fix would instead be to changedefaultPeriodback to5 * time.Minuteininternal/config/update.go. I went with the documentation fix as the lower-risk option, but happy to switch this to a code change instead if you prefer — your call.