docs: fix traciing typo in tracing config key - #5437
Open
latent-9 wants to merge 1 commit into
Open
Conversation
The top-level tracing configuration key is documented as `traciing` (double i) in docs/configuration.md; the actual key is `tracing` (config/config.go, `yaml:"tracing"`), so a config copied from the docs fails to load with an unknown-field error. Signed-off-by: latent-9 <296084221+latent-9@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation corrects the top-level tracing configuration key from ChangesTracing documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
TheMeier
approved these changes
Aug 4, 2026
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.
The top-level tracing configuration key in the config reference is misspelled
traciing(double i):The actual key is
tracing— seeconfig/config.go(TracingConfig ... yaml:"tracing,omitempty"), and the surrounding comment and the<tracing_config>type anchor both usetracing. A config copied from the docs currently fails to load with an unknown-field error. Fixed the key totracing.Signed-off-by: latent-9 296084221+latent-9@users.noreply.github.com