All rules

A long name used again after its short name was defined

defined-name-repeatedon by default (info)Japanese / English

A party given a short name ("the Supplier") and later written out in full

Example

Flagged
# Services Agreement This agreement is between Harbour Works Ltd (the "Supplier") and North Trading Inc (the "Customer"). 1. The Customer pays Harbour Works Ltd within thirty days of each invoice.
What chaff prints
5:22 "Harbour Works Ltd" was given the short name "Supplier" on line 3
Fixed
# Services Agreement This agreement is between Harbour Works Ltd (the "Supplier") and North Trading Inc (the "Customer"). 1. The Customer pays the Supplier within thirty days of each invoice.
What chaff prints
no finding
chaff.yaml used for this example
genre: legal/contract

How to fix

Use the short name the contract defined. Where the full name is needed (a signature block, a list beside other companies), leave it.

Why it matters

Once a contract says "Harbour Works Ltd (the "Supplier")", it refers to the Supplier as "the Supplier". Writing "Harbour Works Ltd" again later makes the reader check whether it is the same party in the same role. chaff takes the name right before an inline definition's bracket (a run of nouns and names) as the long name, and points at each later use of it. Lines that give the short name too, little more than the name (a signature block), a field whose value is the name (Attention: Harbour Works Ltd, Legal Department), or a signature at the end with no label, the name and the parts of an address (Harbour Works Ltd, Customer Support) are not read. A field whose label is a contact label (Contact:, Attention:) is not read however long its value or wherever the name sits in it, unless the name goes on as a sentence.

What it does not flag

Uses before the short name is defined, uses on a line that also gives the short name, lines holding little more than the name (a signature block), names shorter than four characters, one-word English names, lower-case words, dates and amounts (with respect thereto, January 26, 2015, $1.00), short names that contain the long one, names narrowed by the word before them ("the Beta Preview", "Customer's Web site"), names that are defined terms themselves, a name after a joining word (書面または電磁的記録(以下「書面等」), Registered Mail or Courier Delivery: the bracket names the whole list), a name inside a longer word, and a bracket that names each or all of several things ((each, a "Certificate"), (collectively, the "Plans")), which names the head of the clause before it rather than its last words, are not reported. The legal genres run this rule.

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: defined-name-repeated — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax defined-name-repeated --why "reason"
Turn it off for the team (chaff.yaml)
rules: defined-name-repeated: off
Technical details
Layer
L3
Status
stable
Severity
info
Languages
Japanese and English
Suited to
legal, docs, academic, literature, speech
Reads from the document
structure, pos

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
legal/contract, legal/statute, legal/judgment, legal/patent
Turned off by the genre in
docs/manual, docs/faq, docs/glossary, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
Not suited to, and not run in
technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes

Genres

Message

"{name}" was given the short name "{term}" on line {line}

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/defined-name-repeated.yaml