Cliched closing

closing-clicheon by defaultJapanese / English

A stock closing such as "Hope this helps" that leaves the reader nothing

Example

Flagged

## Summary Changing one line of the settings made the build twice as fast. Hope this helps!

What chaff prints

3:65 Closes with "hope this helps"

Fixed

## Summary Changing one line of the settings made the build twice as fast. Next, we will try running the tests in parallel.

What chaff prints

no finding

chaff.yaml used for this example

genre: blog/tech

How to fix

Name the one thing you want the reader to take away.

Why it matters

A closing that only thanks the reader leaves nothing behind.

What it does not flag

Only the last four paragraphs of the last section are checked, with or without headings; the document's first paragraph and "to sum up" earlier in the text are ordinary links and are not reported. List items are not checked.

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 closing-cliche --why "reason"

Turn it off for the team (chaff.yaml)

rules: closing-cliche: off

Technical details

Layer: L2
Status: stable
Severity: warning
Languages: Japanese and English
Suited to: 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	reported once there are 1
normal	reported once there are 1
relaxed	reported once there are 2

By genre

Runs by default in: blog/tech, blog/essay, blog/owned-media
Turned off by the genre in: 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
Not suited to, and not run in: technical/spec, technical/readme, business/proposal, business/report, business/email, business/press-release, business/meeting-notes

Genres

Message

Closes with "{matched}"

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/closing-cliche.yaml