-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Closed
Labels
accepting prsGo ahead, send a pull request that resolves this issueGo ahead, send a pull request that resolves this issuerepo maintenancethings to do with maintenance of the repo, and not with code/docsthings to do with maintenance of the repo, and not with code/docs
Description
Suggestion
I've been using https://github.com/gajus/eslint-plugin-jsdoc for a little while now in my personal repos and quite like it. Especially its "plugin:jsdoc/recommended-typescript-error"
preset has quite a few rules that generally adhere to how we ask folks to write things in this repo.
Also of interest is https://github.com/gajus/eslint-plugin-jsdoc/blob/aefceca7413ac0263ed1b58127fff4efca89de4f/docs/rules/informative-docs.md. IMO we should enable this to help folks accustomed to writing comments like Split out to #8156@param id the id
(it happens sometimes).
Metadata
Metadata
Assignees
Labels
accepting prsGo ahead, send a pull request that resolves this issueGo ahead, send a pull request that resolves this issuerepo maintenancethings to do with maintenance of the repo, and not with code/docsthings to do with maintenance of the repo, and not with code/docs