docs(codex): the example contradicted the paragraph under it - #1044
Merged
Conversation
PR #1022 made fast_mode opt-in and documented that unset adds no [features] table. The config example two lines above still showed that table unconditionally, so a reader following the example expected output they will not get. One comment line in each of the five locales, marking the block as conditional.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThe Codex integration guides now state that ChangesCodex integration documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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.
What
PR #1022 made
fast_modeopt-in: unset now leaves the user's config alone and creates no[features]table. The guide says so — and two lines above it, the config example still shows that table unconditionally.A reader following the example expects output they will not get.
Change
One comment line above the block in each of the five locales, marking it conditional. No prose changes, no behavior claims altered.
Follow-up to #1022, found while verifying that PR against current
dev.Summary by CodeRabbit
[features]table andfast_modesetting are added only whenfastModeis configured.[features]table is created whenfastModeremains unset.