All rules

List items in mixed forms

list-item-form-mixon by default (info)Japanese / English

One list mixing phrases with sentences, or verb-first items with noun-first ones

Example

Flagged
Before you start: - Install the command-line tool - Create an account on the website - The configuration file in your home folder
What chaff prints
5:3 "The configuration file in your home folder" opens with a noun phrase; the other items in this list open with a verb (1 of 3)
Fixed
Before you start: - Install the command-line tool - Create an account on the website - Put the configuration file in your home folder
What chaff prints
no finding
chaff.yaml used for this example
genre: blog/tech

How to fix

Rewrite the odd item in the form the others use. If it really is a different kind of thing, move it to its own list or paragraph.

Why it matters

Items in one list are easiest to compare when they share a form. When one item is a full sentence among noun phrases, or opens with a verb (Install …) among items that open with a noun (The server …), it reads as a different kind of thing. chaff does not decide which form is right; within one list it points at the items in the less common form.

What it does not flag

Lists of fewer than three items, lists where the less common form is more than a third (used on purpose), one-word items, "Label: value" items, items holding code or a link, items that end as the words of a link (相談窓口はこちら, click here), lists whose items end in a comma, a semicolon or "and" (one sentence split into items), and quoted lists are not checked. A capitalised name (Cover Letter), a word that is also a verb (Design documents), an adjective before a preposition (Free of charge, Clean up), an -ing or -ed word (Reviewing the code, Improved access) and Secure or Open before a bare noun (Secure configuration) are not judged by their first word. A word followed by "the", "a" or "your" (Open the app) and a series holding a verb (Scope, estimate and describe) open with a verb; "youre …" opens with its subject, as "you love …" does. An item ending in a colon (Other kinds:) leads into what follows, so its ending is not judged. Marks after an item (!!) and a footnote reference ([^1]) are set aside, and Japanese あり or なし right after a noun (翻訳あり) is read as a noun ending. Legal, literary, speech and meeting-notes genres do not run this rule.

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: list-item-form-mix — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax list-item-form-mix --why "reason"
Turn it off for the team (chaff.yaml)
rules: list-item-form-mix: off
Technical details
Layer
L2
Status
stable
Severity
info
Languages
Japanese and English
Suited to
blog, business, technical, docs, academic, legal, 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).

strictreported when the less common form is 49% of the list's items or less
normalreported when the less common form is 34% of the list's items or less
relaxedreported when the less common form is 20% of the list's items or less

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, docs/manual, docs/faq, docs/glossary, academic/paper
Turned off by the genre in
business/meeting-notes, legal/contract, legal/statute, legal/judgment, legal/patent, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript

Genres

Message

"{written}" is in a different form from the other items in this list ({count} of {of})

"{written}" is a phrase; the other items in this list are sentences ({count} of {of})

"{written}" is a sentence; the other items in this list are phrases ({count} of {of})

"{written}" opens with a verb; the other items in this list open with a noun phrase ({count} of {of})

"{written}" opens with a noun phrase; the other items in this list open with a verb ({count} of {of})

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/list-item-form-mix.yaml