Inclusive Comments

ID

python.inclusive_comments

Severity

info

Remediation Complexity

trivial

Remediation Risk

low

Remediation Effort

low

Resource

Best Practice

Language

Python

Tags

comments, inclusive

Description

Reports # comments whose text contains a non-inclusive term (the default deny-list: blacklist, whitelist, master, slave, grandfather, dummy, sanity).

# the master node bootstraps replicas        # FLAW

# the primary node bootstraps replicas       # OK

Configuration

The deny-list is configurable via the rule’s terms property in the scan profile.

Rationale

Inclusive language costs almost nothing to adopt and removes friction for readers from many backgrounds. The terms in the default list have neutral, equally clear alternatives.

Remediation

Replace the flagged term with a precise alternative: primary/replica, allow-list/deny-list, legacy, placeholder, etc.

References