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

Components: Add missing @param docs #22971

Merged
merged 1 commit into from
Jun 6, 2020
Merged

Components: Add missing @param docs #22971

merged 1 commit into from
Jun 6, 2020

Conversation

ocean90
Copy link
Member

@ocean90 ocean90 commented Jun 6, 2020

Description

See #22907.

Fixes the following JSDoc warnings:

Details 
packages/components/src/menu-item/index.js
  18:1  warning  Missing JSDoc @param "ref.children" declaration    jsdoc/require-param
  18:1  warning  Missing JSDoc @param "ref.info" declaration        jsdoc/require-param
  18:1  warning  Missing JSDoc @param "ref.className" declaration   jsdoc/require-param
  18:1  warning  Missing JSDoc @param "ref.icon" declaration        jsdoc/require-param
  18:1  warning  Missing JSDoc @param "ref.shortcut" declaration    jsdoc/require-param
  18:1  warning  Missing JSDoc @param "ref.isSelected" declaration  jsdoc/require-param
  18:1  warning  Missing JSDoc @param "ref.role" declaration        jsdoc/require-param
  21:0  warning  Missing @param "ref.children"                      jsdoc/check-param-names
  21:0  warning  Missing @param "ref.info"                          jsdoc/check-param-names
  21:0  warning  Missing @param "ref.className"                     jsdoc/check-param-names
  21:0  warning  Missing @param "ref.icon"                          jsdoc/check-param-names
  21:0  warning  Missing @param "ref.shortcut"                      jsdoc/check-param-names
  21:0  warning  Missing @param "ref.isSelected"                    jsdoc/check-param-names
  21:0  warning  Missing @param "ref.role"                          jsdoc/check-param-names

packages/components/src/placeholder/index.js
  16:1  warning  Missing JSDoc @param "props.icon" declaration            jsdoc/require-param
  16:1  warning  Missing JSDoc @param "props.children" declaration        jsdoc/require-param
  16:1  warning  Missing JSDoc @param "props.label" declaration           jsdoc/require-param
  16:1  warning  Missing JSDoc @param "props.instructions" declaration    jsdoc/require-param
  16:1  warning  Missing JSDoc @param "props.className" declaration       jsdoc/require-param
  16:1  warning  Missing JSDoc @param "props.notices" declaration         jsdoc/require-param
  16:1  warning  Missing JSDoc @param "props.preview" declaration         jsdoc/require-param
  16:1  warning  Missing JSDoc @param "props.isColumnLayout" declaration  jsdoc/require-param
  19:0  warning  Missing @param "props.icon"                              jsdoc/check-param-names
  19:0  warning  Missing @param "props.children"                          jsdoc/check-param-names
  19:0  warning  Missing @param "props.label"                             jsdoc/check-param-names
  19:0  warning  Missing @param "props.instructions"                      jsdoc/check-param-names
  19:0  warning  Missing @param "props.className"                         jsdoc/check-param-names
  19:0  warning  Missing @param "props.notices"                           jsdoc/check-param-names
  19:0  warning  Missing @param "props.preview"                           jsdoc/check-param-names
  19:0  warning  Missing @param "props.isColumnLayout"                    jsdoc/check-param-names

packages/components/src/range-control/utils.js
  33:1  warning  Missing JSDoc @param "root0" declaration               jsdoc/require-param
  33:1  warning  Missing JSDoc @param "root0.min" declaration           jsdoc/require-param
  33:1  warning  Missing JSDoc @param "root0.max" declaration           jsdoc/require-param
  33:1  warning  Missing JSDoc @param "root0.value" declaration         jsdoc/require-param
  55:1  warning  Missing JSDoc @param "root0" declaration               jsdoc/require-param
  55:1  warning  Missing JSDoc @param "root0.onShow" declaration        jsdoc/require-param
  55:1  warning  Missing JSDoc @param "root0.onHide" declaration        jsdoc/require-param
  55:1  warning  Missing JSDoc @param "root0.onMouseMove" declaration   jsdoc/require-param
  55:1  warning  Missing JSDoc @param "root0.onMouseLeave" declaration  jsdoc/require-param
  55:1  warning  Missing JSDoc @param "root0.timeout" declaration       jsdoc/require-param

packages/components/src/toolbar-group/index.js
  20:1  warning  Missing JSDoc @param "props.title" declaration  jsdoc/require-param
  43:0  warning  Missing @param "props.title"                    jsdoc/check-param-names

packages/components/src/toolbar/index.js
  17:1  warning  Missing JSDoc @param "props.__experimentalAccessibilityLabel" declaration  jsdoc/require-param
  22:0  warning  Missing @param "props.__experimentalAccessibilityLabel"                    jsdoc/check-param-names

packages/components/src/tree-grid/index.js
  38:1  warning  Missing JSDoc @param "root0" declaration           jsdoc/require-param
  38:1  warning  Missing JSDoc @param "root0.children" declaration  jsdoc/require-param

packages/components/src/tree-grid/roving-tab-index.js
  11:1  warning  Missing JSDoc @param "root0" declaration           jsdoc/require-param
  11:1  warning  Missing JSDoc @param "root0.children" declaration  jsdoc/require-param

packages/components/src/unit-control/unit-select-control.js
  13:1  warning  Missing JSDoc @param "root0" declaration             jsdoc/require-param
  13:1  warning  Missing JSDoc @param "root0.className" declaration   jsdoc/require-param
  13:1  warning  Missing JSDoc @param "root0.isTabbable" declaration  jsdoc/require-param
  13:1  warning  Missing JSDoc @param "root0.options" declaration     jsdoc/require-param
  13:1  warning  Missing JSDoc @param "root0.onChange" declaration    jsdoc/require-param
  13:1  warning  Missing JSDoc @param "root0.size" declaration        jsdoc/require-param
  13:1  warning  Missing JSDoc @param "root0.value" declaration       jsdoc/require-param

packages/components/src/visually-hidden/index.js
  11:1  warning  Missing JSDoc @param "root0" declaration            jsdoc/require-param
  11:1  warning  Missing JSDoc @param "root0.as" declaration         jsdoc/require-param
  11:1  warning  Missing JSDoc @param "root0.className" declaration  jsdoc/require-param

How has this been tested?

npm run lint-js packages/components/src/

Types of changes

Bug fix

@ocean90 ocean90 added [Type] Bug An existing feature does not function as intended [Package] Components /packages/components labels Jun 6, 2020
@github-actions
Copy link

github-actions bot commented Jun 6, 2020

Size Change: 0 B

Total Size: 1.12 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 193 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 568 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.33 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.52 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
mkaz approved these changes Jun 6, 2020
View reviewed changes
Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

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

Confirmed 👍
Looks good and clears warnings

@ocean90 ocean90 merged commit defc1f1 into master Jun 6, 2020
@ocean90 ocean90 deleted the fix/components-missing-params branch June 6, 2020 16:03
@github-actions github-actions bot added this to the Gutenberg 8.3 milestone Jun 6, 2020
@ocean90 ocean90 mentioned this pull request Jun 6, 2020
Closed
40 tasks
@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mkaz mkaz mkaz approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra

@chrisvanpatten chrisvanpatten Awaiting requested review from chrisvanpatten

@youknowriad youknowriad Awaiting requested review from youknowriad

Assignees
No one assigned
Labels
[Package] Components /packages/components [Type] Bug An existing feature does not function as intended [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
@ocean90 @mkaz @youknowriad