Avoid periods at the end of headings (EK00022)
Headings are labels, not sentences, so they read better without a terminal period across your documentation. EkLine flags a period at the end of a heading and suggests removing it (rule EK00022).
Why remove periods from headings in documentation?
Section titled “Why remove periods from headings in documentation?”A trailing period turns a heading into something that looks like an unfinished sentence. Headings work as short labels that readers scan, and a period adds visual noise without adding meaning. Removing it keeps every heading on your page consistent and easier to skim.
What EkLine flags
Section titled “What EkLine flags”EK00022 matches a period at the end of a heading and suggests the same heading without it.
- ❌ Incorrect: Install the CLI.
- ✅ Correct: Install the CLI
- ❌ Incorrect: Configure your project.
- ✅ Correct: Configure your project
How to fix
Section titled “How to fix”Remove the period from the end of the heading. Keep the rest of the wording as it is.
Should a heading end with a period?
Section titled “Should a heading end with a period?”No. A heading is a short label that readers scan, and a trailing period makes it look like an unfinished sentence.
How is this rule different from EK00023?
Section titled “How is this rule different from EK00023?”EK00022 covers only a trailing period, while EK00023 covers any end punctuation, including question marks and colons.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00022 |
| Category | Titles and headings |
| Default severity | Warning |
| Enabled by default | No |
Ignore this rule
Section titled “Ignore this rule”To keep a period in one heading, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00022 -- heading quotes a full sentence -->## Read the notice "Back up your data first."To disable the rule across your project, add it to the ignore list in your configuration file.