An amount that is not what its label's formula gives
formula-amount-mismatchon by defaultJapanese / English
An amount that is not what its label's formula ("5% of the sale price") gives
Example
How to fix
Check the amount it is worked out from, the rate and any fixed part, and correct the amount or the label.
Why it matters
When a statement writes how a fee is worked out in its label ("Commission (5% of the sale price)"), readers pay it without checking. It goes wrong when the price is changed and the fee is not, when a fixed part or the tax is left out, or when a digit is mistyped. When a label holds "rate% of name" (or "name × rate%") and its line ends in one amount, the rate is applied to the amount the document labels with that name (Sale price | $324,000.00), a fixed amount after "plus" is added, and the result is compared with the line's amount. A label saying tax is included adds the rate it states, else the one rate the document states beside a tax word.
What it does not flag
Rounding down, to the nearest or up, before or after the tax, to the cent or to the unit, is read as right. Nothing is compared when no line labels the named amount, when two such lines give different amounts, when the label holds two rates with names or an amount other than the fixed part, when the currencies differ, or when the line's amount is written with a word of scale. A label saying tax is included is not compared when no rate is stated in it, in the document or in the document's profile, or when the document states two rates. A formula written in a sentence is not read.
Turning it off or relaxing it
Technical details
- Layer
- L3
- Status
- stable
- Severity
- warning
- 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).
| 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, speech/address, speech/transcript
- Turned off by the genre in
- literature/fiction, literature/essay, literature/poetry, literature/play
Message
{written} is not "{formula}" worked out on the {name} {base} ({expected})
This page is built from the rule's definition file:packages/chaff/rules/formula-amount-mismatch.yaml