You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]
The text was updated successfully, but these errors were encountered:
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 ofwarn
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 onwarn
for the rest of the repo.Priority
[Nice to Have]
The text was updated successfully, but these errors were encountered: