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

Block Editor: Update createBlockCompleter for @param rules #22975

Merged
merged 2 commits into from
Jun 6, 2020

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Jun 6, 2020

Description

Update JSDoc for block-editor/src/autocompleters/block.js

See #22907.

How has this been tested?

Run: npm run lint-js packages/block-editor/src/autocompleters

npm run lint-js packages/block-editor/src/autocompleters

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

C:\Users\mkaz\src\wp\gutenberg\packages\block-editor\src\autocompleters\block.js
  84:1  warning  Missing JSDoc @param "root0" declaration                                  jsdoc/require-param
  84:1  warning  Missing JSDoc @param "root0.getBlockInsertionParentClientId" declaration  jsdoc/require-param
  84:1  warning  Missing JSDoc @param "root0.getInserterItems" declaration                 jsdoc/require-param
  84:1  warning  Missing JSDoc @param "root0.getSelectedBlockName" declaration             jsdoc/require-param

Types of changes

JSDoc string.

@github-actions
Copy link

github-actions bot commented Jun 6, 2020

Size Change: +807 B (0%)

Total Size: 1.13 MB

Filename Size Change
build/a11y/index.js 1.14 kB +1 B
build/annotations/index.js 3.62 kB +2 B (0%)
build/autop/index.js 2.83 kB +1 B
build/block-directory/index.js 6.75 kB -1 B
build/block-editor/index.js 106 kB +6 B (0%)
build/block-library/index.js 127 kB -21 B (0%)
build/block-serialization-default-parser/index.js 1.88 kB -2 B (0%)
build/block-serialization-spec-parser/index.js 3.1 kB +1 B
build/blocks/index.js 48.1 kB +3 B (0%)
build/components/index.js 194 kB +802 B (0%)
build/core-data/index.js 11.4 kB +4 B (0%)
build/data/index.js 8.45 kB -1 B
build/date/index.js 5.47 kB +2 B (0%)
build/dom-ready/index.js 569 B +1 B
build/edit-post/index.js 303 kB +1 B
build/edit-site/index.js 15.5 kB +2 B (0%)
build/edit-widgets/index.js 9.34 kB +4 B (0%)
build/editor/index.js 44.7 kB +2 B (0%)
build/format-library/index.js 7.72 kB +3 B (0%)
build/hooks/index.js 2.13 kB -3 B (0%)
build/i18n/index.js 3.56 kB +1 B
build/keyboard-shortcuts/index.js 2.51 kB -1 B
build/media-utils/index.js 5.3 kB +2 B (0%)
build/notices/index.js 1.79 kB +1 B
build/nux/index.js 3.41 kB +1 B
build/plugins/index.js 2.56 kB +1 B
build/primitives/index.js 1.5 kB -2 B (0%)
build/redux-routine/index.js 2.85 kB -1 B
build/server-side-render/index.js 2.68 kB +1 B
build/token-list/index.js 1.28 kB -1 B
build/viewport/index.js 1.85 kB -1 B
build/wordcount/index.js 1.17 kB -1 B
ℹ️ View Unchanged
Filename Size Change
build/api-fetch/index.js 3.4 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/style-rtl.css 892 B 0 B
build/block-directory/style.css 892 B 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/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/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/data-controls/index.js 1.29 kB 0 B
build/deprecated/index.js 771 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/style-rtl.css 5.43 kB 0 B
build/edit-post/style.css 5.43 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/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/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/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/html-entities/index.js 621 B 0 B
build/is-shallow-equal/index.js 711 B 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/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/priority-queue/index.js 789 B 0 B
build/rich-text/index.js 14.8 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/url/index.js 4.06 kB 0 B
build/warning/index.js 1.14 kB 0 B

compressed-size-action

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.

Thanks for helping with fixing the warnings! 🙌

packages/block-editor/src/autocompleters/block.js Outdated Show resolved Hide resolved
👍

Co-authored-by: Dominik Schilling <dominikschilling+git@gmail.com>
@mkaz mkaz merged commit dac6b18 into master Jun 6, 2020
@mkaz mkaz deleted the docs/22907-autocomp branch June 6, 2020 18:09
@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 [Feature] Document Outline An option that outlines content based on a title and headings used in the post/page [Type] Developer Documentation Documentation for developers and removed [Type] Code Quality Issues or PRs that relate to code quality [Feature] Document Outline An option that outlines content based on a title and headings used in the post/page labels Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Block editor /packages/block-editor [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants