Skip to content
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

Merged
merged 2 commits into from
Aug 3, 2019

Conversation

dsifford
Copy link
Contributor

@dsifford dsifford commented Aug 2, 2019

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:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.

Note: This is my first cherry-picked PR so hopefully I didn't blow anything up!

Copy link
Contributor

@talldan talldan left a 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.

packages/block-library/src/embed/util.js Outdated Show resolved Hide resolved
packages/rich-text/src/split.js Outdated Show resolved Hide resolved
Copy link
Member

@gziolo gziolo left a 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.

package-lock.json Outdated Show resolved Hide resolved
@talldan talldan added [Type] Code Quality Issues or PRs that relate to code quality [Type] Developer Documentation Documentation for developers labels Aug 2, 2019
@dsifford
Copy link
Contributor Author

dsifford commented Aug 2, 2019

Fixes have been applied for the issues mentioned.

I ran npm run build to regenerate the docs and what you see in the diff is all that changed for me. Let me know if I missed something.

@gziolo gziolo merged commit 5920ab8 into master Aug 3, 2019
@gziolo gziolo deleted the fix/eslint-plugin-jsdoc-warnings branch August 3, 2019 19:58
@youknowriad youknowriad added this to the Gutenberg 6.3 milestone Aug 9, 2019
gziolo pushed a commit that referenced this pull request Aug 29, 2019
…6870)

* chore: fix all JSDoc eslint errors/warnings across the entire repository

* fix: address code review comments
gziolo pushed a commit that referenced this pull request Aug 29, 2019
…6870)

* chore: fix all JSDoc eslint errors/warnings across the entire repository

* fix: address code review comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Code Quality Issues or PRs that relate to code quality [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants