chore: lint JSDoc with eslint-plugin-jsdoc#124
Merged
Conversation
danvk
commented
Jun 8, 2023
| @@ -1,3 +1,4 @@ | |||
| /* eslint-disable no-undef */ | |||
Collaborator
Author
There was a problem hiding this comment.
I got a warning about this file not being included in tsconfig.json, so I fixed that. That resulted in prettier and eslint running over this, which standardized the quotes and formatting.
| /** | ||
| * INTERNAL ATOMS | ||
| */ | ||
| /** INTERNAL ATOMS */ |
Collaborator
Author
There was a problem hiding this comment.
These got shortened to the one-line form. But really they shouldn't be JSDoc comments at all (they could just be inline comments, or /* ... */ comments -- not jsdoc).
|
|
||
| /** | ||
| * Returns a callback that will only call the passed function when it has not been called for the specified time | ||
| * |
Collaborator
Author
There was a problem hiding this comment.
This is jsdoc/tag-lines. I'd like to enforce something like PEP 257: a summary line followed by a blank line, followed by a longer description. eslint-plugin-jsdoc used to have a rule that did that but they recently deleted it gajus/eslint-plugin-jsdoc#1031 (comment)
sehyod
previously approved these changes
Jun 9, 2023
cguedes
previously approved these changes
Jun 9, 2023
sergioramos
changed the title
eslint-plugin-jsdoc
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 is helpful for enforcing some norms around JSDoc comments. See https://github.com/refstudio/refstudio/pull/105/files#discussion_r1223202950
In particular:
gets auto-fixed to the one-line form:
/** short comment */