-
-
Notifications
You must be signed in to change notification settings - Fork 31.6k
Require JsDoc on validators #44893
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
Comments
We already use Lines 41 to 42 in e84e2e6
But then we turn a bunch of them off: Lines 304 to 314 in e84e2e6
So maybe enabling one of those disabled rules will accomplish what you are looking for? |
Does #44896 do what you are looking for? Or are there validators in other files that you are looking to apply JSDoc comments to? |
Yes this was what I was looking for. Thanks @Trott |
Closes: #44893 PR-URL: #44896 Fixes: #44893 Reviewed-By: Zeyu "Alex" Yang <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
What is the problem this feature will solve?
This change will enforce the use of JSDocs in internal validators and make it easier for developers to contribute the validators with correct parameters (and auto-completion)
What is the feature you are proposing to solve the problem?
Using an eslint rule to enforce jsdoc for
lib/validators.js
What alternatives have you considered?
Nothing
The text was updated successfully, but these errors were encountered: