Z517: HEADING_PUNCTUATION

• Severity: Error

  ---

  Penalty: 0.0 points | Category: general

• Remediation & Opt-In

  ---

  Auto-Fixable: No | Opt-In: No

---

Description

A heading ends with trailing punctuation such as a period (.), colon (:), or semicolon (;).

Headings serve as labels and document outline nodes; ending them with sentence-terminating punctuation compromises typographical consistency. Question marks (?) and exclamation points (!) are permitted when appropriate.

---

How to Fix

Remove the trailing period, colon, or semicolon from the heading.

Run zenzic fix --apply to automatically remove trailing punctuation from headings across your documentation.

---

Suppression

Suppress with an inline comment:

<!-- zenzic:ignore:Z517 -->

---

Reference

See the Finding Codes Index for finding code details.