Closed JoshuaKGoldberg closed 3 months ago
There is already an excludedTags
array option... It just isn't currently documented.
Aha! #1153 - that must be why it didn't come up in my searches. Nice. Thanks - will send a docs PR.
:tada: This issue has been resolved in version 48.2.2 :tada:
The release is available on:
Your semantic-release bot :package::rocket:
Motivation
jsdoc/informative-docs
will scan the body and all tags of a JSDoc tag for informative-ness. This is good and intended in most cases. But sometimes, there are tags that are used as categorization / metadata and only coincidentally match the name of the construct they're documenting. For example:Standalone reproduction of that snippet for reference: https://github.com/JoshuaKGoldberg/repros/tree/jsdoc-informative-docs-category-tag
Current behavior
Desired behavior
Can we add an option to the rule to allow a list of tags to be ignored? Say,
ignoredTags
?Alternatives considered
An inline disable comment is doable, but clutters the code and is generally inconvenient.