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.

Sign up for GitHub

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

Jump to bottom

Block Editor: JSDoc warnings fix #22976

Merged
merged 4 commits into from
Jun 6, 2020
Merged

Block Editor: JSDoc warnings fix #22976

merged 4 commits into from
Jun 6, 2020

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Jun 6, 2020

Description

Fixes JSDoc warnings in block-editor components:

  • block-navigation/tree.js
  • block-toolbar/util.js

See #22907

How has this been tested?

Test for two files:
npm run lint-js packages/block-editor/src/components/block-navigation/tree.js
npm run lint-js packages/block-editor/src/components/block-toolbar/utils.js

Previous result:

npm run lint-js packages/block-editor/src/components/block-navigation/tree.js

> gutenberg@8.2.1 lint-js C:\Users\mkaz\src\wp\gutenberg
> wp-scripts lint-js "packages/block-editor/src/components/block-navigation/tree.js"


C:\Users\mkaz\src\wp\gutenberg\packages\block-editor\src\components\block-navigation\tree.js
  15:1  warning  Missing JSDoc @param "props.__experimentalFeatures" declaration  jsdoc/require-param

npm run lint-js packages/block-editor/src/components/block-toolbar/utils.js
> gutenberg@8.2.1 lint-js C:\Users\mkaz\src\wp\gutenberg
> wp-scripts lint-js "packages/block-editor/src/components/block-toolbar/utils.js"


C:\Users\mkaz\src\wp\gutenberg\packages\block-editor\src\components\block-toolbar\utils.js
  19:1  warning  Missing JSDoc @param "root0" declaration                  jsdoc/require-param
  19:1  warning  Missing JSDoc @param "root0.ref" declaration              jsdoc/require-param
  19:1  warning  Missing JSDoc @param "root0.isFocused" declaration        jsdoc/require-param
  19:1  warning  Missing JSDoc @param "root0.debounceTimeout" declaration  jsdoc/require-param
  19:1  warning  Missing JSDoc @param "root0.onChange" declaration         jsdoc/require-param
  89:1  warning  Missing JSDoc @param "root0" declaration                  jsdoc/require-param
  89:1  warning  Missing JSDoc @param "root0.ref" declaration              jsdoc/require-param
  89:1  warning  Missing JSDoc @param "root0.debounceTimeout" declaration  jsdoc/require-param
  89:1  warning  Missing JSDoc @param "root0.onChange" declaration         jsdoc/require-param

Types of changes

JSDoc updates.

@mkaz mkaz requested a review from ocean90 June 6, 2020 16:50
@ocean90 ocean90 mentioned this pull request Jun 6, 2020
Closed
40 tasks
@github-actions
Copy link

github-actions bot commented Jun 6, 2020 •
edited
Loading

Size Change: 0 B

Total Size: 1.13 MB

ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.62 kB 0 B
build/api-fetch/index.js 3.4 kB 0 B
build/autop/index.js 2.83 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 6.75 kB 0 B
build/block-directory/style-rtl.css 892 B 0 B
build/block-directory/style.css 892 B 0 B
build/block-editor/index.js 106 kB 0 B
build/block-editor/style-rtl.css 11.4 kB 0 B
build/block-editor/style.css 11.4 kB 0 B
build/block-library/editor-rtl.css 7.87 kB 0 B
build/block-library/editor.css 7.87 kB 0 B
build/block-library/index.js 127 kB 0 B
build/block-library/style-rtl.css 7.72 kB 0 B
build/block-library/style.css 7.72 kB 0 B
build/block-library/theme-rtl.css 684 B 0 B
build/block-library/theme.css 686 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 48.1 kB 0 B
build/components/index.js 194 kB 0 B
build/components/style-rtl.css 19.5 kB 0 B
build/components/style.css 19.5 kB 0 B
build/compose/index.js 9.31 kB 0 B
build/core-data/index.js 11.4 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.45 kB 0 B
build/date/index.js 5.47 kB 0 B
build/deprecated/index.js 771 B 0 B
build/dom-ready/index.js 569 B 0 B
build/dom/index.js 3.17 kB 0 B
build/edit-navigation/index.js 8.25 kB 0 B
build/edit-navigation/style-rtl.css 918 B 0 B
build/edit-navigation/style.css 919 B 0 B
build/edit-post/index.js 303 kB 0 B
build/edit-post/style-rtl.css 5.43 kB 0 B
build/edit-post/style.css 5.43 kB 0 B
build/edit-site/index.js 15.5 kB 0 B
build/edit-site/style-rtl.css 2.96 kB 0 B
build/edit-site/style.css 2.96 kB 0 B
build/edit-widgets/index.js 9.34 kB 0 B
build/edit-widgets/style-rtl.css 2.4 kB 0 B
build/edit-widgets/style.css 2.4 kB 0 B
build/editor/editor-styles-rtl.css 425 B 0 B
build/editor/editor-styles.css 428 B 0 B
build/editor/index.js 44.7 kB 0 B
build/editor/style-rtl.css 4.26 kB 0 B
build/editor/style.css 4.27 kB 0 B
build/element/index.js 4.64 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.72 kB 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 621 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.51 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.12 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/media-utils/index.js 5.3 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.41 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.5 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 14.8 kB 0 B
build/server-side-render/index.js 2.68 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.28 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@mkaz @ocean90
Apply suggestions from code review
619a069 
Thanks!

Co-authored-by: Dominik Schilling <dominikschilling+git@gmail.com>
ocean90
ocean90 approved these changes Jun 6, 2020
View reviewed changes
Copy link
Member

@ocean90 ocean90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more alignment fix, otherwise it's looking good.

packages/block-editor/src/components/block-toolbar/utils.js Outdated Show resolved Hide resolved
@mkaz @ocean90
Update packages/block-editor/src/components/block-toolbar/utils.js
8e761d3 
Co-authored-by: Dominik Schilling <dominikschilling+git@gmail.com>
@mkaz mkaz merged commit c409b71 into master Jun 6, 2020
@mkaz mkaz deleted the fix/22907-jsdocs-bebn branch June 6, 2020 19:42
@github-actions github-actions bot added this to the Gutenberg 8.3 milestone Jun 6, 2020
@mkaz mkaz added [Package] Block editor /packages/block-editor [Type] Code Quality Issues or PRs that relate to code quality labels Jun 7, 2020
@youknowriad youknowriad added [Type] Developer Documentation Documentation for developers and removed [Type] Code Quality Issues or PRs that relate to code quality labels Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ocean90 ocean90 ocean90 approved these changes

@ellatrix ellatrix Awaiting requested review from ellatrix

@youknowriad youknowriad Awaiting requested review from youknowriad

Assignees
No one assigned
Labels
[Package] Block editor /packages/block-editor [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 8.3
Development

Successfully merging this pull request may close these issues.
3 participants
@mkaz @ocean90 @youknowriad