Empty list item
empty-list-itemon by defaultJapanese / English
A list item with only a label ("Owner:") and no value, or with nothing in it
Example
How to fix
Write the value. If it is not decided, write "TBD" and when it will be. If the item is not needed, remove it.
Why it matters
An item holding only a label ("Owner:") while the other items of the list give theirs a value, or an item with nothing after its bullet. The reader cannot tell a gap from an undecided point.
What it does not flag
A label-only item is not reported when no other item in its list has a "label: value" form (a blank form to fill in). An item followed by a nested list or paragraph (a lead-in) is not reported. Markdown lists only.
Turning it off or relaxing it
Technical details
- Layer
- L1
- Status
- stable
- Severity
- warning
- Languages
- Japanese and English
- Suited to
- business, technical, blog, legal, docs, academic, literature, speech
- Reads from the document
- markdown
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, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
Message
Nothing after "{name}" (the other items in this list give a value)
This list item is empty
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/empty-list-item.yaml