chore: add eslint-jsdoc-plugin to eslint #1585
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
This plugin helps us detect some things the built-in jsdoc rules can't, like whether there is an example or not. As expected, the addition of this plugin helped detect some minor JSDoc issues. Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
jhermsmeier
reviewed
Jul 11, 2017
| - error | ||
| jsdoc/newline-after-description: | ||
| - error | ||
| jsdoc/require-example: |
There was a problem hiding this comment.
Do we really want to force an example for every function & method? Seems to me that'd be a bit of overkill, and introduce a lot of noise in the code.
There was a problem hiding this comment.
There's a few places in this PR where it adds /* eslint-disable jsdoc/require-example */ ;-)
There was a problem hiding this comment.
Yeah, we can enable the exception for things like React components, etc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This plugin helps us detect some things the built-in jsdoc rules can't,
like whether there is an example or not.
As expected, the addition of this plugin helped detect some minor JSDoc
issues.
Signed-off-by: Juan Cruz Viotti jv@jviotti.com