One table header written two ways
table-header-varianton by default (info)Japanese / English
The same column header written two ways across tables (Owner and Owners)
Example
How to fix
If it is the same column, write it the way the rest of the document does. If it really is a different column, give it a name that shows the difference.
Why it matters
When one table says "Owner" and another says "Owners" for the same column, the reader wonders whether they are different columns and stops to compare. chaff collects the header row of every table and the left cell of every two-column table (a field name). It treats two headers as one label when they are the same after folding width, case, spaces, hyphens and middle dots and dropping an ending that leaves the meaning alone (s, es). It then points at the less common spelling in the document, without deciding which is right.
What it does not flag
Headers without letters (numbers or symbols only), tables inside a code sample, and headers that differ in meaning (Date and Time) are not compared. Inline HTML tags in a header (<div style="…">) and the spaces inside them are not seen by the reader and are not compared. The left cell is collected only in two-column tables.
Turning it off or relaxing it
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
- 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 | reported when the less common spelling is 50% of the header's uses or less |
|---|---|
| normal | reported when the less common spelling is 50% of the header's uses or less |
| relaxed | reported when the less common spelling is 34% of the header's uses 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, 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
The table header "{written}" here, where the document's other tables write "{usual}" ({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/table-header-variant.yaml