Skip to content

VBC-414: please-in-cli

warning

Category: docs
Analysis: Regex (line by line)
File types: .md, .sh
Scope: source code only, ignoring anything inside strings and comments
Tags: ux cli

What it reports

Avoid using 'Please' in technical instructions at line {line}. Use direct imperative mood (e.g., 'Run...' instead of 'Please run...').

Flagged

md
Please run the migration first.

Not flagged

md
Run the migration first.

Pattern

regex
Please run|Please make sure

Released under the MIT License.