Unrendered emphasis marks
unrendered-emphasison by defaultJapanese / English
"**" or "__" that Markdown cannot pair and shows as written
Example
How to fix
If it was left open, add the closing "**". If punctuation sits inside the mark, move the mark outside the punctuation, or put a space outside it.
Why it matters
"**" and "__" turn into bold only when Markdown can pair them; otherwise they show as written. Besides one left open ("**important"), a mark with punctuation inside and a letter outside (Japanese "**「重要」**です") cannot close under CommonMark's rules, and the reader sees the "**".
What it does not flag
A mark inside a word ("2**10", "snake__case"), a mark with spaces on both sides, runs of three or more (dividers and blanks to fill, "____"), names such as "__init__", and marks in code or quotations are not reported.
Turning it off or relaxing it
Technical details
- Layer
- L1
- Status
- stable
- Severity
- warning
- Languages
- Japanese and English
- Suited to
- business, technical, blog, legal, docs, academic, literature, speech
- Reads from the document
- markdown
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 | error |
|---|---|
| normal | warning |
| 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
Message
"{mark}" is not turned into bold and shows as written
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/unrendered-emphasis.yaml