All rules

A name outside the announced list

outside-announced-liston by defaultJapanese / English

A platform or language named later that the list given earlier left out

Example

Flagged
The app is supported on Windows and macOS. Setup takes five minutes. It is also supported on Linux.
What chaff prints
1:94 "Linux" is not in the list given on line 1 (Windows, macOS)
Fixed
The app is supported on Windows, macOS and Linux. Setup takes five minutes. It is also supported on Linux.
What chaff prints
no finding

How to fix

If the list is out of date, add the name to it; if the later sentence is wrong, correct it.

Why it matters

Listing "supported on Windows and macOS" and later writing "also runs on Linux" leaves the reader unable to tell which list is true. Usually a platform was added and the first list was not updated, or a sentence came from another product's page. chaff does not decide which is right; it points at the name the first list does not have. The words that announce a list are in each language's lexicon, and only words of the same group (platforms, languages) are compared.

What it does not flag

Only proper nouns right next to a listing word (supported on, available in, version) are read. The first sentence naming two or more is the list, and earlier sentences are not checked. Words of different groups (platforms and languages) are not compared.

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: outside-announced-list — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax outside-announced-list --why "reason"
Turn it off for the team (chaff.yaml)
rules: outside-announced-list: off
Technical details
Layer
L3
Status
stable
Severity
warning
Languages
Japanese and English
Suited to
business, technical, blog, legal, docs, academic, literature, speech
Reads from the document
pos

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).

stricterror
normalwarning
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, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript

Genres

Message

"{name}" is not in the list given on line {listLine} ({list})

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/outside-announced-list.yaml