Skip to content

Z519: WEASEL_WORDS

  • Severity: Error


    Penalty: 0.0 points | Category: general

  • Remediation & Opt-In


    Auto-Fixable: No | Opt-In: No


Description

A word or phrase that weakens technical writing (such as "clearly", "simply", "obviously", "basically", or "very") was detected in prose.

Weasel words undermine clarity and precision by introducing subjective, vague, or dismissive qualifiers.


How to Fix

Remove the weasel word or replace it with concrete, assertive, and verifiable explanation:

<!-- Before -->
Clearly, you simply configure the gateway.

<!-- After -->
Configure the gateway.

Configuration

Configure the list of weasel words to detect in .zenzic.toml:

[policies]
weasel_words = ["clearly", "simply", "obviously", "basically", "very"]

Suppression

Suppress with an inline comment:

<!-- zenzic:ignore:Z519 -->

Reference

See the Finding Codes Index for finding code details.