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: Link to unit tests from rule documentation #15207
Conversation
In the Resources section at the bottom of each rule's documentation, we already link to the rule's implementation and the documentation's Markdown source. This adds a link to the rule's unit tests.
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.
I was just thinking if this. 👍
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 👍🏻
Hi @btmills!, thanks for the Pull Request The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.
Read more about contributing to ESLint here |
marked accepted, as no objections from the team. 😄 |
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 autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
In the Resources section at the bottom of each rule's documentation, we already link to the rule's implementation and the documentation's Markdown source. I've wished multiple times to have a handy link to the unit tests as well to see if a case is covered. This adds that link.
Is there anything you'd like reviewers to focus on?
For example, I ran
npm run gensite
locally, and here's the diff for theaccessor-pairs
documentation: