Skip to content

VBC-324: condescending-language ​

warning

Category: docs
Analysis: Regex (line by line)
File types: .md, .txt
Scope: source code only, ignoring anything inside strings and comments
Off by default. Name it in slopless.config.json to turn it on.
Tags: docs

What it reports ​

Condescending or vague language '{match}' detected at line {line}. Be direct and avoid assumptions about the reader's knowledge.

Flagged ​

md
Simply run the installer.
md
Just run npm install.

Not flagged ​

md
Run the installer.
md
We just released version 2.

Pattern ​

regex
\b(?:simply|basically|obviously|clearly|everyone knows|as anyone can see)\b|\bjust\s+(?:run|do|add|use|call|type|install|click|open|set)\b|\beasily\b

Released under the MIT License.