Z501: PLACEHOLDER
Severity: warning
Penalty: 2.0 points
Category: content
Auto-fixable: 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:
Bad (Triggers Z501)¶
<!-- BAD: Placeholder text in documentation prose -->
## Configuration Steps
TODO: Complete this section before publishing.
Good (Resolves Z501)¶
<!-- GOOD: Complete technical documentation prose -->
## Configuration Steps
Set `strict = true` in `.zenzic.toml` to enforce zero-error pipeline execution.
Configuration¶
# .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.