Not the team's spelling
preferred-termwhen listed in chaff.yamlJapanese / English
A spelling the team chose not to use ("e-mail" for "email"), from chaff.yaml
Example
How to fix
Change it to "the spelling listed under prefer". Where it must stay (a product's own name, a quotation), silence it with stet and the reason.
Why it matters
Writing the same thing two ways ("e-mail" and "email") makes a reader wonder whether they differ, and a search misses one of them. Which way wins is the team's choice, so list pairs (the spelling to avoid, then the one to use) under `prefer` in chaff.yaml. With nothing listed, this rule says nothing.
What it does not flag
Only the pairs under prefer in chaff.yaml are checked. With nothing listed, it says nothing.
Turning it off or relaxing it
Technical details
- Layer
- L2
- Status
- stable
- Severity
- warning
- Languages
- Japanese and English
- Suited to
- business, blog, technical, 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).
| strict | reported once there are 1 |
|---|---|
| normal | reported once there are 1 |
| relaxed | reported once there are 3 |
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, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
Message
Write "{preferred}", not "{matched}"
Sources
This page is built from the rule's definition file:packages/chaff/rules/preferred-term.yaml