-
Notifications
You must be signed in to change notification settings - Fork 4.3k
chore(eslint): lint jsdocs #33202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(eslint): lint jsdocs #33202
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #33202 +/- ##
=======================================
Coverage 80.78% 80.78%
=======================================
Files 232 232
Lines 14111 14111
Branches 2453 2453
=======================================
Hits 11400 11400
Misses 2431 2431
Partials 280 280
Flags with carried forward coverage won't be shown. Click here to find out more.
|
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Comments on closed issues and PRs are hard for our team to see. |
Adds a dependency to
eslint-plugin-jsdocand utilizes the following linter rules (for now):These ensure that no one leaving
@paramor@returnswithout a description. In most cases, these are auto-generated and then the contributor forgets to add an actual description. They are useless without a description, so I am just removing the tags entirely.Our official stance is that these jsdoc tags are optional, but if you write them, they must have a description.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license