Chore: enable jsdoc/require-description #12365
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
eslint-deprecated
bot
added
the
triage
kaicataldo
added
chore
kaicataldo
commented
Oct 3, 2019
| @@ -67,7 +67,7 @@ describe("RuleTester", () => { | |||
| let ruleTester; | |||
|
|
|||
| /** | |||
| * @description A helper function to verify Node.js core error messages. | |||
| * A helper function to verify Node.js core error messages. | |||
There was a problem hiding this comment.
The default configuration doesn't check for @description tags. We can use descriptionStyle: "any" to allow both styles, but since this is the only instance in our codebase, it seemed like a good idea to just go with the default behavior. Happy to change it if others disagree, though.
kaicataldo
force-pushed
the
jsdoc-require-description
branch
from
32a392d
to
6f367b0
Compare
platinumazure
approved these changes
Oct 3, 2019
This was referenced Nov 9, 2019
This was referenced Mar 11, 2020
This was referenced Mar 26, 2020
This was referenced Apr 3, 2020
eslint-deprecated
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.
What is the purpose of this pull request? (put an "X" next to item)
[ ] 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
[x] Other, please explain:
What changes did you make? (Give an overview)
Following up on #12336 (review), this PR enables the
jsdoc/require-descriptionrule, usingeslint-disable-*comments for the 30 instances where a description is missing. As @mysticatea suggested, this will ensure we don't add any new JSDoc blocks that are missing descriptions.Is there anything you'd like reviewers to focus on?
Nothing in particular!