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

Require parameter type documentation (JSDoc + ESLint) #942

Open
garbados opened this issue Oct 7, 2021 · 0 comments
Open

Require parameter type documentation (JSDoc + ESLint) #942

garbados opened this issue Oct 7, 2021 · 0 comments

Comments

@garbados
Copy link
Contributor

garbados commented Oct 7, 2021

Is your feature request related to a problem? Please describe.

Developers have expressed frustration that the JSDoc+ESLint configuration enforces the presence of @param documentation without enforcing a documentation of parameter types.

Feature Description

Use the jsdoc/require-param-type rule to require (or warn about) parameter type documentation.

Additional context

Putting this rule on error instead of warn would prompt a great deal of work fixing up old code. It may be worthwhile to limit this requirement to public-facing code while leaving it on warn for the rest of the repo.

Priority

[Nice to Have]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant