Skip to content

Comments

Add missing docblocks to Yoast-Components#803

Merged
IreneStr merged 7 commits intodevelopfrom
eslint-missing-JSDoc
Jan 31, 2019
Merged

Add missing docblocks to Yoast-Components#803
IreneStr merged 7 commits intodevelopfrom
eslint-missing-JSDoc

Conversation

@Dieterrr
Copy link
Contributor

@Dieterrr Dieterrr commented Jan 7, 2019

Summary

This PR can be summarized in the following changelog entry:

  • N/A.

Relevant technical choices:

  • Adds missing docblocks, reducing the amount of eslint warnings by 51.
  • Sets maxWarnings from 384 to 323.

Test instructions

This PR can be tested by following these steps:

  • No changed functionality, but the the following warnings should be fixed:
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/App.js
--
91:1  warning Missing JSDoc comment  require-jsdoc
92:13 warning Missing JSDoc comment  require-jsdoc
103:12 warning Missing JSDoc comment  require-jsdoc
112:10 warning Missing JSDoc comment  require-jsdoc
118:14 warning Missing JSDoc comment  require-jsdoc
135:9  warning Missing JSDoc comment  require-jsdoc
176:20 warning Missing JSDoc comment  require-jsdoc
183:8  warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/app/AppWrapper.js
11:20 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/app/KeywordExample.js
23:16 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/app/KeywordSuggestionWrapper.js
5:22 warning Missing JSDoc comment require-jsdoc
15:35 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/app/SnippetEditorExample.js
49:16 warning Missing JSDoc comment require-jsdoc
84:11 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/app/SvgIconsWrapper.js
45:19 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/app/WizardWrapper.js
7:1  warning Missing JSDoc comment require-jsdoc
11:23 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/AlgoliaSearch/AlgoliaSearcher.js
26:1 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/AlgoliaSearch/ArticleContent.js
20:1 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/basic/ErrorBoundary.js
20:16 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/basic/Loader.js
4:16 warning Missing JSDoc comment  require-jsdoc
69:2  warning propType "className" is not required, but has no corresponding defaultProp declaration react/require-default-props
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/OnboardingWizard/components/Choice.js
28:19 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/OnboardingWizard/tests/wizardTest.js
19:21 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/CornerstoneContent/components/CornerstoneToggle.js
12:1  warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/DashboardWidget/components/WordpressFeed.js
72:31 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/Shared/components/ScoreAssessments.js
40:25 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/Shared/components/SectionTitle.js
31:29 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/Shared/components/StackedProgressBar.js
24:28 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/Shared/components/Toggle.js
57:1 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/Shared/components/UpsellButton.js
117:29 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/Shared/components/YoastModal.js
26:1 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/Shared/tests/CollapsibleTest.js
99:20 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/components/__mocks__/ReplacementVariableEditorStandalone.js
6:1 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/components/Mention.js
20:24 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/components/ReplacementVariableEditor.js
20:1 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/components/SettingsSnippetEditor.js
13:1 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/components/SettingsSnippetEditorFields.js
18:1 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/components/Shared.js
9:27 warning Missing JSDoc comment require-jsdoc
15:26 warning Missing JSDoc comment require-jsdoc
83:32 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/components/SnippetEditor.js
102:1  warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/components/SnippetEditorFields.js
41:1 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/tests/serializationTest.js
192:21 warning Missing JSDoc comment require-jsdoc
217:21 warning Missing JSDoc comment require-jsdoc
251:21 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetEditor/tests/SnippetEditorTest.js
29:32 warning Missing JSDoc comment require-jsdoc
37:23 warning Missing JSDoc comment require-jsdoc
42:25 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetPreview/components/HelpTextWrapper.js
65:1  warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetPreview/components/SnippetPreview.js
252:16 warning Missing JSDoc comment  require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/composites/Plugin/SnippetPreview/tests/SnippetPreviewTest.js
17:32 warning Missing JSDoc comment require-jsdoc
25:23 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/render.js
9:1 warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/utils/i18n.js
68:2  warning Missing JSDoc comment require-jsdoc
69:14 warning Missing JSDoc comment require-jsdoc
73:9  warning Missing JSDoc comment require-jsdoc
 
/Users/dieterschalk/Code/VVV/www/wordpress-default/public_html/wp-content/plugins/yoast-components/utils/intlProvider.js
5:40 warning Missing JSDoc comment require-jsdoc

Run grunt check to check.

@Dieterrr Dieterrr changed the title Eslint missing js doc Add missing docblocks to Yoast-Components Jan 7, 2019
@IreneStr IreneStr self-assigned this Jan 17, 2019
Copy link
Contributor

@IreneStr IreneStr left a comment

Choose a reason for hiding this comment

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

CR done 🚧

}

/**
* You're a wizard, Harry.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why? 😂

Copy link
Contributor

Choose a reason for hiding this comment

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

@atimmer approves if you add a serious description above it 😄

IreneStr and others added 2 commits January 17, 2019 14:50
Co-Authored-By: Dieterrr <gargamelk@hotmail.com>
@IreneStr IreneStr added this to the Yoast SEO 9.7 milestone Jan 17, 2019
@IreneStr
Copy link
Contributor

2nd CR 👍

@IreneStr IreneStr modified the milestones: Yoast SEO 9.7, Yoast SEO 9.8 Jan 31, 2019
@IreneStr IreneStr merged commit fcd9d2a into develop Jan 31, 2019
@IreneStr IreneStr deleted the eslint-missing-JSDoc branch January 31, 2019 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants