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

Chore: enable jsdoc/require-description #12365

Merged
merged 1 commit into from Oct 10, 2019
Merged

Conversation

@kaicataldo
Copy link
Member

kaicataldo commented Oct 3, 2019

What is the purpose of this pull request? (put an "X" next to item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:

What changes did you make? (Give an overview)
Following up on #12336 (review), this PR enables the jsdoc/require-description rule, using eslint-disable-* comments for the 30 instances where a description is missing. As @mysticatea suggested, this will ensure we don't add any new JSDoc blocks that are missing descriptions.

Is there anything you'd like reviewers to focus on?
Nothing in particular!

@eslint eslint bot added the triage label Oct 3, 2019
@kaicataldo kaicataldo added chore and removed triage labels Oct 3, 2019
@@ -67,7 +67,7 @@ describe("RuleTester", () => {
let ruleTester;

/**
* @description A helper function to verify Node.js core error messages.
* A helper function to verify Node.js core error messages.

This comment has been minimized.

Copy link
@kaicataldo

kaicataldo Oct 3, 2019

Author Member

The default configuration doesn't check for @description tags. We can use descriptionStyle: "any" to allow both styles, but since this is the only instance in our codebase, it seemed like a good idea to just go with the default behavior. Happy to change it if others disagree, though.

@kaicataldo kaicataldo force-pushed the jsdoc-require-description branch from 32a392d to 6f367b0 Oct 3, 2019
@kaicataldo kaicataldo requested a review from mysticatea Oct 4, 2019
Copy link
Member

mysticatea left a comment

LGTM, thank you!

@kaicataldo kaicataldo merged commit e5637ba into master Oct 10, 2019
16 checks passed
16 checks passed
Verify Files
Details
Test (ubuntu-latest, 8.x)
Details
Test (ubuntu-latest, 10.x)
Details
Test (ubuntu-latest, 12.x)
Details
Test (windows-latest, 12.x)
Details
Test (macOS-latest, 12.x)
Details
Browser Test
Details
commit-message Commit message follows guidelines
Details
continuous-integration Build #20191003.6 succeeded
Details
continuous-integration (Test on Node.js 10 (Linux)) Test on Node.js 10 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Linux)) Test on Node.js 12 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Windows)) Test on Node.js 12 (Windows) succeeded
Details
continuous-integration (Test on Node.js 12 (macOS)) Test on Node.js 12 (macOS) succeeded
Details
continuous-integration (Test on Node.js 8 (Linux)) Test on Node.js 8 (Linux) succeeded
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
@kaicataldo kaicataldo deleted the jsdoc-require-description branch Oct 10, 2019
@eslint eslint bot locked and limited conversation to collaborators Apr 9, 2020
@eslint eslint bot added the archived due to age label Apr 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.