Skip to content

no-vague-suppression-description

Generic suppression descriptions do not make the exception auditable.

Why

Generic reasons satisfy review conventions without making the suppressed risk auditable or removable.

Fix

Name the concrete tool mismatch or safety invariant and the condition that would allow removal. Cite an upstream issue or affected version when that is the durable boundary.

Examples

Before — flagged Generic reason does not make the suppression auditable
adapter.py
value = vendor.value # ruff: ignore[attr-defined] -- false positive
After — preferred Concrete runtime mismatch explains the suppression
adapter.py
value = vendor.value # type: ignore[attr-defined] -- vendor stubs omit the runtime field