Skip to content

Add exemptedBy option to exempt JSDoc description when a return tag exists. #2

@junhaoliao

Description

@junhaoliao

Shall we add exemptedBy: ["inheritdoc", "return"] to

eslint-config-yscope/common.js

Lines 1429 to 1436 in 458f22e

"jsdoc/require-description": [
"warn",
{
checkConstructors: false,
checkGetters: false,
checkSetters: false,
},
],

so that we can achieve below from our docs guideline?

The description should be omitted if the return value description would repeat the description.

Reference

https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#options

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions