docs: Fix custom rule schema docs #17115
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
|
|
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
mdjermanovic
added
the
accepted
Thanks for catching this! You're right, the docs are factually incorrect there. |
mdjermanovic
requested changes
Apr 24, 2023
aladdin-add
pushed a commit
to aladdin-add/eslint
that referenced
this pull request
Jun 15, 2023
1 task
aladdin-add
added a commit
to aladdin-add/eslint
that referenced
this pull request
Jun 15, 2023
aladdin-add
added a commit
that referenced
this pull request
Jun 21, 2023
credits: https://github.com/domdomegg Refs: * #17225 * #17115
eslint-github-bot
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Corrected the docs to state that either way option schemas are specified, they should no longer include severities. This has been the behaviour since ESLint 2.x! (git blame shows that these lines haven't been changed for over 8 years, way back to ESLint 1.x).
I've also removed some superfluous content: the text after the code sample can be coalesced into the sentence before it, and the comment on how to learn about JSON schema is unnecessary given the link to the JSON Schema site can be updated to the learn page (which itself already contains the ebook recommendation). Removing this duplicated content makes it easier to quickly read, and avoid breaking up the content so developers don't miss the specific eslint gotchas (e.g. the
$refbreaking).Is there anything you'd like reviewers to focus on?