docs(config): document pattern-prefixed knob naming (#379)#394
Closed
trilamsr wants to merge 1 commit into
Closed
Conversation
New per-pattern knobs MUST use <Pattern><Knob> prefix. Bare names (NCCLHangThreshold etc.) kept for backward-compat with pre-v0.4 values.yaml; no rename in v1.0-rc1. v2.0 may nest. Closes #379. Signed-off-by: Tri Lam <tri@maydow.com>
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
config.gocarries three knob-naming styles (bareNCCLHangThreshold, prefixedCheckpointerHangBackwardWindow, top-levelJoinWindow). The prefixed shape is correct going forward; renaming the bare names for v1.0-rc1 would break every existingvalues.yaml.Root cause
Convention emerged across waves, never written down. Future detectors had no signal to pick the prefixed shape.
Fix
Add an 8-line top-of-file comment documenting the convention. No code/field renames. v2.0 nesting deferred (see issue body).
Test plan
attribute-namespace-check(pre-push hook) — greengo build ./module/processor/patterndetectorprocessor/...— greenCloses #379.