Z511: EXCESSIVE_SENTENCE_LENGTH
Severity: warning
Penalty: 1.0 point
Category: content
Auto-fixable: No
Description¶
A prose sentence exceeds the configured maximum word count threshold (default: 40 words).
Extremely long sentences reduce reader comprehension, increase cognitive load, and hurt technical documentation readability.
How to Fix¶
- Break the sentence into two or more shorter sentences using punctuation (
.,;). - Use bullet points or lists to structure complex multi-part statements.
Configuration¶
You can configure the maximum allowed sentence length in .zenzic.toml:
Suppression¶
To suppress this warning for a specific sentence, add an inline comment directive above the paragraph:
Reference¶
See the Finding Codes Index for finding code details.