A reference whose name does not match its target's heading

reference-title-mismatchon by default (info)Japanese / English

A reference's title ("Section 5 (Privacy)") that differs from the heading

Example

Flagged

# Terms ## 1. Scope For fees, see Section 2 (Refunds). ## 2. Pricing The fee is monthly.

What chaff prints

5:26 Section 2 is called "Refunds" here, but its heading is "Pricing"

Fixed

# Terms ## 1. Scope For fees, see Section 2 (Pricing). ## 2. Pricing The fee is monthly.

What chaff prints

no finding

How to fix

Check whether the number or the name is right and correct the other. If the numbers shifted, check the other references too.

Why it matters

When "Section 5 (Confidentiality)" points at a Section 5 headed "Liability", the reader cannot tell whether the number or the name is right. It happens when sections are added or removed and the numbers shift, but the references are not updated. The name in brackets or quotes right after a reference is compared with the target's heading; they agree when either contains the other.

What it does not flag

References whose target has no heading or cannot be told apart, references to another document, brackets holding a number or a word like "above" or "see", and brackets closed by a Japanese full stop (a note on the scope, 「第七項を除く。」) are left alone.

Turning it off or relaxing it

Silence this one spot (in the document)

Relax it for the team (the reason is kept as a comment in chaff.yaml)

npx chaffjs relax reference-title-mismatch --why "reason"

Turn it off for the team (chaff.yaml)

rules: reference-title-mismatch: off

Technical details

Layer: L3
Status: stable
Severity: info
Languages: Japanese and English
Suited to: business, technical, blog, legal, docs, academic, literature, speech
Reads from the document: structure

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

normal	info
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, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript

Genres

Message

{label} is called "{name}" here, but its heading is "{heading}"

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/reference-title-mismatch.yaml