All rules

Amounts of one size written two ways

amount-scale-consistencyon by default (info)Japanese / English

Amounts written with and without a scale word ("$1.5 million", "$2,500,000")

Example

Flagged
The total is $4 million: $1.5 million for design and $2,500,000 for building.
What chaff prints
1:54 "$2,500,000" here, where the document writes amounts of this size like "$4 million"
Fixed
The total is $4 million: $1.5 million for design and $2.5 million for building.
What chaff prints
no finding

How to fix

Write amounts of the same size the way the rest of the document does.

Why it matters

When amounts of one size are written two ways ("$1.5 million for design, $2,500,000 for building"), the reader counts the zeros again and wonders whether the two are different kinds of amount. It happens when quotes and emails are pasted together. Small amounts in digits and large ones with "million" is a normal way of writing, so only amounts of the same order of magnitude are compared, and the way that order uses less is pointed at. Amounts in table cells are compared too.

What it does not flag

Amounts of different sizes ("$480" and "$3 million") are not compared; digits for small amounts and "million" for large ones is a normal way of writing. A precise amount ("$1,234,567") cannot be written with "million" and is not compared. An estimate ("about $1.3 million") is not compared, nor is a round figure in the text ("a cap of $1.5 million") whose only counterparts are the exact amounts of a table. Each currency is compared with itself, and code is not read.

Turning it off or relaxing it

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

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

strictwarning
normalinfo
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

"{written}" here, where the document writes amounts of this size like "{usual}"

This page is built from the rule's definition file:packages/chaff/rules/amount-scale-consistency.yaml