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
voxpelli · Nov 28, 2023 · fbd4367 · fbd4367
1 parent 93a7d3c
commit fbd4367
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/base-configs/jsdoc.js b/base-configs/jsdoc.js
@@ -18,6 +18,7 @@ const config = {
     'jsdoc/require-jsdoc': 'off',
     'jsdoc/require-param-description': 'off',
     'jsdoc/require-property-description': 'off',
+    'jsdoc/require-returns': ['warn', { 'publicOnly': true }],
     'jsdoc/require-returns-description': 'off',
     'jsdoc/require-yields': 'off',
     'jsdoc/tag-lines': ['warn', 'never', { 'startLines': 1 }],