Avoid ellipses (EK00011)
Replacing ellipses with complete sentences keeps your documentation definite and clear. Learn why to avoid them, with examples and fixes.
An ellipsis signals a trailing or incomplete thought, and documentation reads better when each point is stated in full. EkLine flags an ellipsis (”…”) (rule EK00011) so you can replace it with a complete sentence.
Why avoid ellipses in documentation?
Section titled “Why avoid ellipses in documentation?”An ellipsis implies that something is left unsaid, and documentation should state each point in full. Trailing dots make instructions and UI strings read as hesitant or unfinished, which leaves readers unsure whether they missed anything. Replacing the ellipsis with a complete sentence removes that doubt and keeps your writing definite.
What EkLine flags
Section titled “What EkLine flags”EK00011 matches an ellipsis (”…”).
- ❌ Incorrect: Loading…
- ✅ Correct: Loading.
- ❌ Incorrect: The list shows recent files and more…
- ✅ Correct: The list shows recent files and more.
How to fix
Section titled “How to fix”Remove the ellipsis and end the sentence with a period, or rewrite the thought as a complete statement.
Why avoid ellipses in documentation?
Section titled “Why avoid ellipses in documentation?”An ellipsis implies something is left unsaid, and documentation should state each point in full. Trailing dots leave readers unsure whether they missed anything.
When is an ellipsis acceptable?
Section titled “When is an ellipsis acceptable?”When you quote a UI string that shows progress exactly, the ellipsis may be intentional. Keep it and ignore the rule for that line.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00011 |
| Category | Consistency |
| Default severity | Warning |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep an ellipsis on one line, add an inline comment:
<!-- ekline-ignore-next-line EK00011 -- matches the button label in the UI -->The button reads Loading...To disable the rule across your project, add it to the ignore list in your configuration file.