Use a single space between words (EK00025)
Consistent single spacing between words keeps your documentation clean and prevents ragged gaps or run-together sentences when it renders.
Consistent single spacing between words and after each period keeps your documentation clean and easy to read. EkLine flags two or more spaces between words, or a missing space after sentence-ending punctuation (rule EK00025).
Why does consistent spacing matter in documentation?
Section titled “Why does consistent spacing matter in documentation?”Uneven spacing is invisible while you type but shows up as ragged gaps or run-together sentences once your documentation renders. A single space between words and after each period keeps paragraphs uniform and easy to read. Consistent spacing also prevents diff noise and helps automated tooling parse your text reliably.
What EkLine flags
Section titled “What EkLine flags”EK00025 matches two or more consecutive spaces between words, or a sentence-ending period with no space before the next word.
- ❌ Incorrect: Save the file. Then restart the service.
- ✅ Correct: Save the file. Then restart the service.
- ❌ Incorrect: The upload ends.Start the next step.
- ✅ Correct: The upload ends. Start the next step.
How to fix
Section titled “How to fix”Replace multiple spaces with a single space, and add a space after any sentence-ending punctuation that lacks one.
Should you use one space or two after a period?
Section titled “Should you use one space or two after a period?”Use a single space. One space after each period keeps paragraphs uniform and matches current style conventions.
Why do extra spaces go unnoticed while typing?
Section titled “Why do extra spaces go unnoticed while typing?”Spacing is invisible as you type but shows up as ragged gaps or run-together sentences once your documentation renders.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00025 |
| Category | Spelling and grammar |
| Default severity | Error |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep the spacing on one line, add an inline comment:
<!-- ekline-ignore-next-line EK00025 -- aligned columns need extra spaces -->name role statusTo disable the rule across your project, add it to the ignore list in your configuration file.