Are Docs Informative

Checks whether a documentation description introduces any new information.
ℹ️

Usage

> See this in action in jsdoc/informative-docs!

``shell
npm i are-docs-informative
`

`ts
import { areDocsInformative } from "are-docs-informative";

areDocsInformative("The user id.", "userId"); // false
areDocsInformative("Retrieved user id.", "userId"); // true
`

$3

The areDocsInformative function can receive a third, optional object parameter.
It can contain any of the following properties.

#### aliases

The aliases option allows indicating words as synonyms (aliases) of each other.

For example, with { aliases: { emoji: ["smiley", "winkey"] } }, the following comment would be considered uninformative:

`ts
/* Default smiley/winkey. /
export const defaultSmiley = "🙂";
`

The default aliases option is:

`json
{
"a": ["an", "our"]
}
`

#### uselessWords

Words that are ignored when searching for one that adds meaning.

For example, with { uselessWords: ["our"] }, the following comment would be considered uninformative:

`ts
/* Our text. /
export const text = ":)";
`

The default uselessWords option is:

`json
["a", "an", "i", "in", "of", "s", "the"]
`

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! ℹ

Contributors

Josh Goldberg 🔧 📖 🚇 💻 🖋 🤔 🚧 📆

> 💝 This package was templated with create-typescript-app` using the Bingo engine.