Z501: PLACEHOLDER¶

Severity: Error

Penalty: 0.0 points | Category: general
Remediation & Opt-In

Auto-Fixable: No | Opt-In: No

Rationale¶

This content quality rule is triggered when stub text or placeholder markers (such as T-O-D-O, Lorem Ipsum, or F-I-X-M-E) are detected within documentation prose intended for publication.

How to Fix¶

Inspect the flagged location in the Markdown file and update the content or configuration:

Failing Pattern (Triggers Z501)

docs/example.md

<!-- BAD: Placeholder text in documentation prose -->
## Configuration Steps

TODO: Complete this section before publishing.

Passing Pattern (Resolves Z501)

docs/example.md

<!-- GOOD: Complete technical documentation prose -->
## Configuration Steps

Set `strict = true` in `.zenzic.toml` to enforce zero-error pipeline execution.

Configuration¶

.zenzic.toml

# .zenzic.toml - Configure placeholder patterns
placeholder_patterns = [
    "(?i)\bTODO\b",
    "(?i)\bFIXME\b",
    "(?i)\bLorem Ipsum\b",
]

Reference¶

See the Finding Codes Index for finding code details.