-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
fix all JSDoc eslint errors/warnings across the entire repository #16870
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good. We'd probably want to merge it as soon as possible to avoid conflicts.
I've avoided commenting on any doc formatting that was already incorrect. I only spotted a couple of things that might need some modification.
Looks like the build failed as there are some altered files after running the build, probably some docs that need to be generated using npm run docs:build
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great PR, I like all the consistency it brings. I can confirm that npm run build
is necessary to move forward.
Fixes have been applied for the issues mentioned. I ran |
…6870) * chore: fix all JSDoc eslint errors/warnings across the entire repository * fix: address code review comments
…6870) * chore: fix all JSDoc eslint errors/warnings across the entire repository * fix: address code review comments
Extracted from #16869
Description
This PR simply fixes any eslint errors/warnings that arose as a result of switching to
eslint-plugin-jsdoc
.How has this been tested?
ESlint runs and there are no longer any warnings associated with the changes to JSDoc-related lints.
Screenshots
N/A
Types of changes
Code quality
Checklist:
Note: This is my first cherry-picked PR so hopefully I didn't blow anything up!