docs: update rule documentation headers #288
Merged
Conversation
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
Use [email protected] for changed formatting
|
This comment was marked as outdated.
This comment was marked as outdated.
jennifer-shehane
approved these changes
Jan 5, 2026
Member
|
🎉 This PR is included in version 5.2.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Situation
[email protected], released Jan 1, 2026, is a breaking change, and following the instructions in the CONTRIBUTING > Document generation causes updates to the heading section of rule documents in the docs/rules directory.
Change
Follow CONTRIBUTING > Document generation using
Add a note regarding the on-going incompatibility issues using eslint-doc-generator with Microsoft Windows.