Heading capitalisation is inconsistent

title-case-consistencyon by default (info)English

Headings that mix Title Case and sentence case

Example

Flagged

# User guide ## Getting started Install the app. ## Changing your settings Open the menu. ## Sharing Files With Your Team Press share.

What chaff prints

11:32 This heading's capitalisation differs from the rest (1 in this document)

Fixed

# User guide ## Getting started Install the app. ## Changing your settings Open the menu. ## Sharing files with your team Press share.

What chaff prints

no finding

How to fix

Match the majority.

Why it matters

Neither Title Case nor sentence case is wrong. Mixed within one document, the headings look like they change level. The document's title (the first heading, when no other heading is as shallow) is a name and is not compared; when the section headings split evenly, the title's style decides. A leading label (Section 3., Day 1:), the names of weekdays and months, and the names the body itself capitalises mid-sentence, all capitalised in either style, count as evidence for neither.

What it does not flag

The document's title (the first heading, when no other heading is as shallow) is a name and is not compared. Neither style is called right.

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 title-case-consistency --why "reason"

Turn it off for the team (chaff.yaml)

rules: title-case-consistency: off

Technical details

Layer: L3
Status: stable
Severity: info
Languages: en
Suited to: blog, business, technical, 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	reported when the minority style has 3 headings or fewer
normal	reported when the minority style has 2 headings or fewer
relaxed	reported when the minority style has 1 headings or fewer

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

This heading's capitalisation differs from the rest ({count} in this document)

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