All rules

A contact written two ways

contact-varianton by defaultJapanese / English

An email or postal address written differently in one place

Example

Flagged
# Contact Email: support@hibari-lab.example Questions about a change can be sent to suport@hibari-lab.example.
What chaff prints
5:41 The email address suport@hibari-lab.example may be a slip for support@hibari-lab.example
Fixed
# Contact Email: support@hibari-lab.example Questions about a change can be sent to support@hibari-lab.example.
What chaff prints
no finding

How to fix

Check which is right and correct the other.

Why it matters

An email address or a company's address is written more than once: at the top and the bottom, under "Contact" and in the governing-law clause. When one place reads privacy@hibarilab.example for privacy@hibari-lab.example, or 2-1-4 Marunouchi for 2-4-1 Marunouchi, the reader cannot tell which is right and may write to one that never arrives. An email address is reported when it is another with a dot or hyphen dropped, or with one word one or two letters off. Addresses written after an address word (Address, head office) on the same street are compared, and one whose block numbers are swapped or one changed, or whose postcode alone differs, is reported.

What it does not flag

Two different addresses (sales@ and support@), addresses that differ only in a digit (support1@ and support2@) and a difference in a word shorter than five letters (hr@ and pr@, sale@ and sales@) are not reported. Only a postal address with an address word (Address, head office) before it on its line, or in a two-column table row named by such a word (| Address | … |), is read; addresses in wider tables are not. Addresses of different offices (a head office and a branch), on different streets, on a street of the same name in another town, with a different count of block numbers, or with two numbers changed are not compared.

Turning it off or relaxing it

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

stricterror
normalwarning
relaxedwarning

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
Turned off by the genre in
literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript

Genres

Message

The email address {written} may be a slip for {other}

The address {written} has other block numbers than {other}

The address {written} has another postcode than the same address {other}

This page is built from the rule's definition file:packages/chaff/rules/contact-variant.yaml