VBC-917: shouting-documentation
warningCategory: docs
Analysis: Regex (line by line)
File types: .md, .txt, .py, .go, .rs, .js, .ts, .tsx, .astro
Scope: comments only
Off by default. Name it in slopless.config.json to turn it on.
Tags: documentation style
What it reports
Sustained all-caps text at line {line}. Shouting does not add emphasis, it costs readability. Use bold or a callout instead.
Flagged
md
READ THIS BEFORE YOU DEPLOY ANYTHINGNot flagged
md
Read this before you deploy.Pattern
regex
\b[A-Z]{3,}\b(?:\s+\b[A-Z]{2,}\b){3,}