All rules

A currency written two ways

currency-notation-consistencyon by default (info)Japanese / English

One currency written two ways in one document, such as "$20" and "USD 20"

Example

Flagged
The base fee is $300, the add-on is $50 and shipping is $20. The discount is USD 10.
What chaff prints
1:78 "USD 10" here, where the document usually writes this currency like "$300" (1 of 4)
Fixed
The base fee is $300, the add-on is $50 and shipping is $20. The discount is $10.
What chaff prints
no finding

How to fix

Match the way the rest of the document writes the currency. If the team has decided, write it in the style guide.

Why it matters

When one currency is written two ways in one document ("$20" and "USD 20", "1,000円" and "¥1,000"), the reader wonders whether a different currency or a different kind of amount is meant. It happens when quotes and notes are pasted together. chaff does not decide which way is right; for each currency it points at the way the document uses less. Amounts in table cells are counted too.

What it does not flag

Each currency is compared with itself, so dollars beside yen is not a mix. When the less common way is over a third of that currency's amounts, the document is read as using both on purpose (USD in tables, $ in prose) and nothing is reported; nor when the two ways are equally common. Code is not read.

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: currency-notation-consistency — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax currency-notation-consistency --why "reason"
Turn it off for the team (chaff.yaml)
rules: currency-notation-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).

strictreported when the less common way is 49% of that currency's amounts or less
normalreported when the less common way is 34% of that currency's amounts or less
relaxedreported when the less common way is 20% of that currency's amounts 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

Genres

Message

"{written}" here, where the document usually writes this currency like "{usual}" ({count} of {of})

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