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
docs: consistency changes #15404
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just a minor suggestion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice work, thanks! I left only two small suggestions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice enhancement. Thank you for your contribution.
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.