A step uses something the list of what you need leaves out
unlisted-item-usedon by defaultJapanese / English
A step that uses an ingredient or a tool missing from the document's own list
Example
How to fix
Add it to the list, or rewrite the step with what the list has.
Why it matters
A reader who gathered everything on the "Ingredients" or "What you need" list stops halfway when a step calls for something the list does not have (pepper, a bucket). Either the list left it out or the step is wrong. Only a noun a numbered step uses is read: the object of a use verb ("add", "put", "stir in"), and, in a document whose list includes tools ("What you need", "Tools"), the thing after "with the" or "in a". It is not reported when the document has written it before the step (in the list, the title or an earlier step), whole or by its last word, nor when it is always at hand and never listed (water, hands, air).
What it does not flag
A document with no list heading, steps without numbers, a noun not in a use frame ("with the", "in a" only in a document that lists tools), anything written before the step, what is always at hand (water, hands, air, plates), and a use that is denied ("do not add") are not reported.
Turning it off or relaxing it
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).
| strict | error |
|---|---|
| normal | warning |
| relaxed | info |
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
Message
"{item}" is not in {list}
This page is built from the rule's definition file:packages/chaff/rules/unlisted-item-used.yaml