New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: consistency changes #15404
Merged
Merged
docs: consistency changes #15404
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
|
nzakas
requested changes
Dec 16, 2021
Thanks, this is some nice work. Just a handful of changes I don’t think we can make but overall looks good.
@nzakas, I think I addressed all your comments. |
mdjermanovic
reviewed
Dec 17, 2021
nzakas
approved these changes
Dec 28, 2021
1 task
1 task
1 task
1 task
1 task
1 task
1 task
1 task
1 task
1 task
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
accepted
There is consensus among the team that this change meets the criteria for inclusion
documentation
Relates to ESLint's documentation
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.
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
[X] Other, please explain:
What changes did you make? (Give an overview)
I've made a bunch of consistency changes to the rules documentation, including:
options
->Options
)## allow
->### allow
)## Rule Details
headers)[object-shorthand](https://eslint.org/docs/rules/object-shorthand)
->[object-shorthand](object-shorthand.md)
)-
->*
). Almost everywhere*
was already used so fixed the few places it wasn't. I also added an entry tomarkdownlint.yml
to ensure future consistency. This also resulted in a couple of changes outside of therules
directory."Rule Details", "Options", "Environments", "Examples", "Known Limitations", "When Not To Use It", "Related Rules", "Compatibility", "Further Reading"
. Especially those last three had quite a few permutations. The order is arbitrary, but made sense to me.Makefile.js
to validate those header names and their orderIs there anything you'd like reviewers to focus on?
This is my first PR to
eslint
and I think I followed all guidelines, but I'm happy to make improvements to the PR if needed.