Disable enforcing JSDoc internals for functions that do not have JSDocs #3
Conversation
This file contains hidden or 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
zachintosh
commented
Jul 14, 2020
|
Running the This code does not yet have a build to check things like that, sorry. |
skye2k2
reviewed
Jul 14, 2020
| 'jsdoc/require-example': 'off', | ||
| 'jsdoc/require-file-overview': 'off', | ||
| 'jsdoc/require-hyphen-before-param-description': 'warn', | ||
| 'jsdoc/require-jsdoc': 'warn', |
There was a problem hiding this comment.
Pretty sure that setting jsdoc/require-jsdoc to off would give you the freedom you desired, while still enforcing good habits for those who choose to use them. With that change, this would only be a minor release, and life would be able to continue with minimal disruption.
There was a problem hiding this comment.
I see. So it wouldn't require us to add jsdocs, but as soon as you do, the other jsdoc rules would kick in. I'd be good with that.
skye2k2
changed the title
skye2k2
approved these changes
Jul 14, 2020
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.
From this point on, only functions that have JSDocs will have the remainder of the rules applied.
Update eslint-plugin-jsdoc: ^20 --> ^29.
Release version 2.1.0.