tldr-pages / tldr-lint

A linting tool to validate tldr pages
https://www.npmjs.com/package/tldr-lint
MIT License
35 stars 20 forks source link

feat: add tldr 020: spelling of "Note: " #308

Closed gutjuri closed 3 months ago

gutjuri commented 3 months ago

closes #298

The linter now rejects "NOTE:" and "note" in the page description and example descriptions.

It does not reject other misspellings like "NoTe:", because 1) I doubt anyone would make such misspellings without actively trying to be disruptive 2) those are easily caught by human reviewers.

Again, I added a unit test and ran the new linter against the entire database.

gutjuri commented 3 months ago

Fine to merge with one approval?

kbdharun commented 3 months ago

Fine to merge with one approval?

Yep