docs: add missing Options section - #565
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (13)
Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review. 📝 WalkthroughWalkthroughThe rule documentation adds missing Options sections and normalizes option heading levels. No rule behavior or option content changes. ChangesRule documentation options alignment
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other Merge Risk: ⚪ Minimal · up to This documentation-only change aligns rule pages with the stated Options-section convention and is ready to merge. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
DMartens
left a comment
There was a problem hiding this comment.
Changes LGTM, thanks. Leaving open for others to look over.
Prerequisites checklist
AI acknowledgment
What is the purpose of this pull request?
To follow the convention proposed in eslint/eslint#20196: every rule doc should have an
Optionssection, even if the rule has no options, so readers can tell at a glance whether a rule is configurable.What changes did you make? (Give an overview)
## Optionssection ("This rule has no options.") to 9 rule docs that lacked one.### Optionsinstead of## Options, and adjusted their option subsections from####to###accordingly.Related Issues
refs eslint/eslint#20196
Is there anything you'd like reviewers to focus on?
Additional comments
Disclosure: I'm a participant of open source contribution program OSSCA
Summary by CodeRabbit