This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
jsdoc-format: check first line of multiline comment #3181
Merged
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.
PR checklist
Overview of change:
Adds a check to
jsdoc-format
to disallow text in the first line of multiline JSDoc comments.Fixes: #1052
Is there anything you'd like reviewers to focus on?
CHANGELOG.md entry:
[new-rule-option]
jsdoc-format
adds option"check-multiline-start"
to enforce the first line of a multiline JSDoc comment to be empty.