Are Docs Informative

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

Usage

See this in action in jsdoc/informative-docs!

1npm i are-docs-informative

1import { areDocsInformative } from "are-docs-informative";
2
3areDocsInformative("The user id.", "userId"); // false
4areDocsInformative("Retrieved user id.", "userId"); // true

Options

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:

1/** Default smiley/winkey. */
2export const defaultSmiley = "🙂";

The default aliases option is:

1{
2	"a": ["an", "our"]
3}

uselessWords

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

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

1/** Our text. */
2export const text = ":)";

The default uselessWords option is:

1["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.