Update rule suggestions link to new docs page #509
Merged
Conversation
This file contains 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
bmish
reviewed
Feb 3, 2024
| @@ -25,7 +25,7 @@ This plugin is for x purpose. | |||
| 🎨 Set in the `stylistic` configuration.\ | |||
| ⌨️ Set in the `typescript` configuration.\ | |||
| 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\ | |||
There was a problem hiding this comment.
Regarding:
I was tempted to also update the link for fixable rules too, since there's an equivalent Fixable Rules heading in the same ESLint docs page. But I kind of like how the two links point to two places and encourage users to read both...!
I think we could fix this by having the two ESLint docs on fixability link to each other.
- https://eslint.org/docs/latest/use/command-line-interface#--fix
- https://eslint.org/docs/latest/use/core-concepts#rule-fixes
Ideally, one doc on a topic links to all the other docs on the same topic...
There was a problem hiding this comment.
bmish
changed the title
bmish
changed the title
This was referenced Feb 3, 2024
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.
Fixes eslint-community/eslint-plugin-eslint-plugin#422.
I was tempted to also update the link for fixable rules too, since there's an equivalent Fixable Rules heading in the same ESLint docs page. But I kind of like how the two links point to two places and encourage users to read both...!