ericcornelissen / webmangler

MIT License
1 stars 2 forks source link

Enable ESLint rule `jsdoc/informative-docs` #443

Open ericcornelissen opened 1 year ago

ericcornelissen commented 1 year ago

Description

As of eslint-plugin-jsdoc v44.0.0 (ref. #441) the rule informative-docs is available to improve documentation. The rule disallows documentation that effectively just repeats the name of the thing it's documenting because in that case the documentation doesn't add anything (i.e., isn't informative).

At this time the rule is disabled because there's too many violations (~60) and fixing them is non-trivial. This issue exists as an effort to move towards having only informative documentation and enabling the rule to ensure that's the case going forward.

The suggested configuration would be:

    "jsdoc/informative-docs": [
      "error",
      {
        aliases: [],
        uselessWords: [
          "a",
          "an",
          "i",
          "in",
          "of",
          "our",
          "s",
          "the",
        ],
      },
    ],