All rules

Word not in the dictionary

unknown-wordon by default (info)English

An English word not in the dictionary but one letter from one ("attched")

Example

Flagged
The report is attched to this email.
What chaff prints
1:15 "attched" is not in the dictionary; did you mean "attached"?
Fixed
The report is attached to this email.
What chaff prints
no finding

How to fix

If it is a typo, correct it. If the word is right, add it to names in chaff.yaml.

Why it matters

An English word that is not in the dictionary but is one letter away from a word that is ("attched" and "attached") is usually a typo. chaff looks words up in the English adapter's dictionary (a word list built from wink-lexicon and WordNet), after taking off endings (-ed, -ing) and prefixes (un-, re-). Words with a capital letter (names, acronyms), words in code and URLs, words used twice or more in the document (usually its own terms), and words with no dictionary word one letter away are not reported. Add a team's own words to names in chaff.yaml.

What it does not flag

Words with a capital letter, words shorter than four letters, words in code, URLs and email addresses, the rest of a word whose first letter is set apart by emphasis or brackets (lobally in **G**lobally, xpressions in [e]xpressions), words used twice or more in the document, words with no dictionary word one letter away, words listed under names in chaff.yaml, and the misspellings known-misspelling reports are not reported. Nor is a word the document also writes in code (`tidyq check`, a code block), since it is a name the document uses. Nor is a search stem ending in a wildcard (vaccin*).

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: unknown-word — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax unknown-word --why "reason"
Turn it off for the team (chaff.yaml)
rules: unknown-word: off
Technical details
Layer
L2
Status
stable
Severity
info
Languages
en
Suited to
business, technical, blog, legal, docs, academic, literature, speech

Levels

Set a level for this rule under rules in chaff.yaml. With nothing set, it runs at the level its genre gives it (see By genre below).

strictwarning
normalinfo
relaxedinfo

This rule has no limit to count to. A level sets how a finding is marked: relaxed keeps the finding and marks it a step lower.

By genre

Runs by default in
technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, legal/contract, legal/statute, legal/judgment, legal/patent, docs/manual, docs/faq, docs/glossary, academic/paper, speech/address, speech/transcript
Turned off by the genre in
literature/fiction, literature/essay, literature/poetry, literature/play

Genres

Message

"{word}" is not in the dictionary; did you mean "{suggestion}"?

Rewrite depth (chaff fix-plan --depth): light — words and sentences; the structure and the voice stay

This page is built from the rule's definition file:packages/chaff/rules/unknown-word.yaml