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
Add publicOnly option to other rules #725
Comments
Sounds good, though I would think adding to the existing rules would be a good idea--hopefully though as a call to some shared utility. As far as listing tag names, this is somewhat related to #467 (which I need to review more carefully as it might have already been implemented with the recent |
Motivation
Add the
publicOnly
option fromrequire-jsdoc
to other rules.Personally I want to require jsdoc for all top-level functions for the types and only require descriptions when the functions are exported.
I am willing to create a PR for this functionality.
Current behavior
Currently only the rule
require-jsdoc
has the optionpublicOnly
Desired behavior
Add the same option to other rules. I would add them to
require-description
,require-param-description
andrequire-returns-description
.Alternatives considered
This could also be a new rule as otherwise many other rules would be modified.
This new rule has a list of tag names requiring a description as an option.
Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.
The text was updated successfully, but these errors were encountered: