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

[eslint] disable some options and manually fix `valid-jsdoc` #2401

merged 1 commit into from Sep 6, 2019


Copy link

commented Sep 6, 2019

  • Disable options requireParamDescription and requireReturnDescription: Personally I find it harmful to add meaningless descriptions to self descriptive params.
  • "requireReturn": false: This option is a misnomer, actually it means "require @returns tag except for void functions". This helps avoid adding lots of @returns {void}.
ljharb approved these changes Sep 6, 2019

@ljharb ljharb force-pushed the golopot:eslint-add-jsdocs branch from 1278477 to 3c72a49 Sep 6, 2019

@ljharb ljharb merged commit 3c72a49 into yannickcr:master Sep 6, 2019

2 of 3 checks passed

continuous-integration/travis-ci/push The Travis CI build is in progress
continuous-integration/travis-ci/pr The Travis CI build passed
coverage/coveralls Coverage remained the same at 97.571%

@golopot golopot deleted the golopot:eslint-add-jsdocs branch Sep 7, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
2 participants
You can’t perform that action at this time.