VBC-934: personal-opinion-docs

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 style

What it reports

Personal opinion language '{match}' in documentation at line {line}. Technical documentation should be objective and factual. Personal opinions erode credibility and confuse readers about whether a recommendation is a design constraint or a preference. Use "this approach" or cite evidence instead.

Flagged

I think this is the better default.

Not flagged

This is the default because it is safer.

Pattern

\b(I think|I believe|I feel that|in my opinion|IMO|IMHO|personally,)\b