Skip to content

Commit 59032cb

Browse files
committed
feat: only require JSDoc returns when public
Trying this out to see whether it seems to be a good idea or not. Related option: https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#options Related PR: gajus/eslint-plugin-jsdoc#1156 Related issue: gajus/eslint-plugin-jsdoc#1137
1 parent 47ae9ef commit 59032cb

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

base-configs/jsdoc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ const config = {
1818
'jsdoc/require-jsdoc': 'off',
1919
'jsdoc/require-param-description': 'off',
2020
'jsdoc/require-property-description': 'off',
21+
'jsdoc/require-returns': ['warn', { 'publicOnly': true }],
2122
'jsdoc/require-returns-description': 'off',
2223
'jsdoc/require-yields': 'off',
2324
'jsdoc/tag-lines': ['warn', 'never', { 'startLines': 1 }],

0 commit comments

Comments
 (0)