Skip to content

Commit 4360d4d

Browse files
chore: enable jsdoc/informative-docs (#397)
## PR Checklist - [x] Addresses an existing open issue: fixes #371 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Enables the rule, with an intentional set of failures.
1 parent 9f3a7e0 commit 4360d4d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

.eslintrc.cjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ module.exports = {
2525
files: ["**/*.ts"],
2626
parser: "@typescript-eslint/parser",
2727
rules: {
28+
// These off-by-default rules work well for this repo and we like them on.
29+
"jsdoc/informative-docs": "error",
30+
2831
// These on-by-default rules don't work well for this repo and we like them off.
2932
"jsdoc/require-jsdoc": "off",
3033
"jsdoc/require-param": "off",

0 commit comments

Comments
 (0)