Skip to content

E2E Test Utils: Add missing param docs for createNewPost()#22948

Merged
ocean90 merged 2 commits intomasterfrom
fix/e2e-test-utils-param-docs
Jun 6, 2020
Merged

E2E Test Utils: Add missing param docs for createNewPost()#22948
ocean90 merged 2 commits intomasterfrom
fix/e2e-test-utils-param-docs

Conversation

@ocean90
Copy link
Copy Markdown
Member

@ocean90 ocean90 commented Jun 5, 2020

Description

See #22907.

Fixes the following JSDoc warnings:

packages/e2e-test-utils/src/create-new-post.js
  11:1  warning  Missing JSDoc @param "obj.postType" declaration          jsdoc/require-param
  11:1  warning  Missing JSDoc @param "obj.title" declaration             jsdoc/require-param
  11:1  warning  Missing JSDoc @param "obj.content" declaration           jsdoc/require-param
  11:1  warning  Missing JSDoc @param "obj.excerpt" declaration           jsdoc/require-param
  11:1  warning  Missing JSDoc @param "obj.showWelcomeGuide" declaration  jsdoc/require-param
  14:0  warning  Missing @param "obj.postType"                            jsdoc/check-param-names
  14:0  warning  Missing @param "obj.title"                               jsdoc/check-param-names
  14:0  warning  Missing @param "obj.content"                             jsdoc/check-param-names
  14:0  warning  Missing @param "obj.excerpt"                             jsdoc/check-param-names
  14:0  warning  Missing @param "obj.showWelcomeGuide"                    jsdoc/check-param-names

How has this been tested?

npm run lint-js packages/e2e-test-utils/src

Types of changes

Bug fix

@ocean90 ocean90 added [Type] Bug An existing feature does not function as intended [Tool] E2E Test Utils /packages/e2e-test-utils labels Jun 5, 2020
@github-actions
Copy link
Copy Markdown

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

Size Change: +1.35 kB (0%)

Total Size: 1.12 MB

Filename Size Change
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 +2 B (0%)
build/block-library/index.js 127 kB +2 B (0%)
build/components/index.js 193 kB +27 B (0%)
build/compose/index.js 9.31 kB +1 B
build/core-data/index.js 11.4 kB -2 B (0%)
build/data/index.js 8.45 kB -2 B (0%)
build/edit-navigation/index.js 8.25 kB +1 B
build/edit-post/index.js 303 kB +284 B (0%)
build/edit-site/index.js 15.5 kB +533 B (3%)
build/edit-widgets/index.js 9.33 kB +506 B (5%) 🔍
build/element/index.js 4.64 kB -1 B
build/format-library/index.js 7.72 kB +1 B
build/list-reusable-blocks/index.js 3.12 kB -1 B
build/nux/index.js 3.41 kB +1 B
build/plugins/index.js 2.56 kB -1 B
build/rich-text/index.js 14.8 kB -2 B (0%)
build/server-side-render/index.js 2.68 kB -2 B (0%)
ℹ️ 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/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/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/style-rtl.css 19.5 kB 0 B
build/components/style.css 19.5 kB 0 B
build/data-controls/index.js 1.29 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/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/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/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/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/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/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 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/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

gziolo
gziolo approved these changes Jun 6, 2020
View reviewed changes
Copy link
Copy Markdown
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.

👍

@ocean90 ocean90 merged commit 4dd2059 into master Jun 6, 2020
@ocean90 ocean90 deleted the fix/e2e-test-utils-param-docs branch June 6, 2020 10:22
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gziolo gziolo gziolo approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra

@nerrad nerrad Awaiting requested review from nerrad

@ntwb ntwb Awaiting requested review from ntwb

Assignees

No one assigned

Labels

[Tool] E2E Test Utils /packages/e2e-test-utils [Type] Bug An existing feature does not function as intended

Projects

None yet

Milestone

Gutenberg 8.3

Development

Successfully merging this pull request may close these issues.

2 participants

@ocean90 @gziolo