Skip to content

docs: add missing Options section - #565

Merged
Pixel998 merged 2 commits into
eslint:mainfrom
BHyeonKim:docs-add-options-section
Sep 14, 2026
Merged

Pixel998 merged 2 commits into
eslint:mainfrom
BHyeonKim:docs-add-options-section

Conversation

@BHyeonKim

@BHyeonKim BHyeonKim commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Prerequisites checklist

AI acknowledgment

  • I did not use AI to generate this PR.
  • (If the above is not checked) I have reviewed the AI-generated content before submitting.

What is the purpose of this pull request?

To follow the convention proposed in eslint/eslint#20196: every rule doc should have an Options section, 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)

  • Added a ## Options section ("This rule has no options.") to 9 rule docs that lacked one.
  • Fixed 4 rule docs that used ### Options instead 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

  • Documentation
    • Added clear “Options” sections to multiple rule pages, including explicit notes when rules have no configurable options.
    • Standardized heading hierarchy across rule documentation for improved consistency and readability.
    • Preserved all existing option descriptions and rule behavior.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Triage Sep 13, 2026
@eslint-github-bot eslint-github-bot Bot added the documentation Improvements or additions to documentation label Sep 13, 2026
@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 291a6ca5-6563-46a6-a111-78ec12023d23

📥 Commits

Reviewing files that changed from the base of the PR and between 876e8b1 and 43c47a2.

📒 Files selected for processing (13)
  • docs/rules/font-family-fallbacks.md
  • docs/rules/no-duplicate-imports.md
  • docs/rules/no-duplicate-keyframe-selectors.md
  • docs/rules/no-empty-blocks.md
  • docs/rules/no-important.md
  • docs/rules/no-invalid-at-rule-placement.md
  • docs/rules/no-invalid-at-rules.md
  • docs/rules/no-invalid-named-grid-areas.md
  • docs/rules/no-unmatchable-selectors.md
  • docs/rules/prefer-logical-properties.md
  • docs/rules/selector-complexity.md
  • docs/rules/use-baseline.md
  • docs/rules/use-layers.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The rule documentation adds missing Options sections and normalizes option heading levels. No rule behavior or option content changes.

Changes

Rule documentation options alignment

Layer / File(s) Summary
Missing Options sections
docs/rules/font-family-fallbacks.md, docs/rules/no-duplicate-imports.md, docs/rules/no-duplicate-keyframe-selectors.md, docs/rules/no-empty-blocks.md, docs/rules/no-important.md, docs/rules/no-invalid-at-rule-placement.md, docs/rules/no-invalid-at-rules.md, docs/rules/no-invalid-named-grid-areas.md, docs/rules/no-unmatchable-selectors.md
Adds an Options section stating that each rule has no options.
Options heading normalization
docs/rules/prefer-logical-properties.md, docs/rules/use-baseline.md, docs/rules/use-layers.md
Promotes the Options headings and option subsection headings by one Markdown level.
Selector complexity heading normalization
docs/rules/selector-complexity.md
Promotes the Options heading and all thirteen option subsection headings by one Markdown level.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 43c47

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)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the primary documentation change: adding missing Options sections. It is concise and directly related to the changeset, which also normalizes existing Options headings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@DMartens DMartens left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM, thanks. Leaving open for others to look over.

@DMartens DMartens moved this from Needs Triage to Merge Candidates in Triage Sep 13, 2026

@Pixel998 Pixel998 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@Pixel998
Pixel998 merged commit 0658aa0 into eslint:main Sep 14, 2026
39 checks passed
@github-project-automation github-project-automation Bot moved this from Merge Candidates to Complete in Triage Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

3 participants