Avoid end punctuation in headings (EK00023)
Headings work as labels, so they read better without a trailing mark of any kind across your documentation. EkLine flags any end punctuation at the end of a heading and suggests removing it (rule EK00023).
Why remove end punctuation from headings in documentation?
Section titled “Why remove end punctuation from headings in documentation?”Headings guide readers through a page, and a punctuation mark at the end makes them read like sentences or questions rather than labels. This rule covers a period, question mark, exclamation point, colon, semicolon, comma, or dash. Removing the trailing mark keeps your headings consistent and easy to scan.
What EkLine flags
Section titled “What EkLine flags”EK00023 matches a heading that ends with any punctuation and suggests the same heading without it.
- ❌ Incorrect: How do I install the CLI?
- ✅ Correct: Install the CLI
- ❌ Incorrect: Getting started:
- ✅ Correct: Getting started
How to fix
Section titled “How to fix”Remove the end punctuation from the heading. Rephrase a question-style heading as a short label, as in How do I install the CLI? to Install the CLI.
Which punctuation marks does this rule cover?
Section titled “Which punctuation marks does this rule cover?”A period, question mark, exclamation point, colon, semicolon, comma, or dash at the end of a heading.
How do you rewrite a question-style heading?
Section titled “How do you rewrite a question-style heading?”Rephrase it as a short label. “How do I install the CLI?” becomes “Install the CLI”.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00023 |
| Category | Titles and headings |
| Default severity | Warning |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep end punctuation in one heading, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00023 -- heading is a direct quotation -->## "Where do I start?"To disable the rule across your project, add it to the ignore list in your configuration file.