Limit sentences to 32 words or fewer (EK00021)
Short sentences carry one idea each and keep your documentation readable, so split any sentence longer than 32 words.
Short sentences carry one idea each, which readers absorb faster than a long chain of clauses, keeping your documentation readable. EkLine flags any sentence longer than 32 words and suggests splitting it (rule EK00021).
Why keep sentences short in documentation?
Section titled “Why keep sentences short in documentation?”Long sentences force readers to hold several ideas in memory before reaching the point, which raises the chance they lose the thread. They also translate poorly and are harder to edit later. Splitting a run-on into two or three sentences makes each claim clear on its own.
What EkLine flags
Section titled “What EkLine flags”EK00021 flags a sentence that runs longer than 32 words.
- ❌ Incorrect: The CLI reads your configuration file and then scans every document in the folder you specify, and it reports each issue with a rule ID, which you can use to look up the rule or silence it later.
- ✅ Correct: The CLI reads your configuration file and scans every document in the folder you specify. It reports each issue with a rule ID. Use that ID to look up the rule or silence it later.
How to fix
Section titled “How to fix”Find a natural break — often where a conjunction like “and” or a relative clause starting with “which” begins — and start a new sentence there. Aim for one idea per sentence.
What is a good sentence length for documentation?
Section titled “What is a good sentence length for documentation?”Aim for one idea per sentence and stay at or below 32 words. Shorter sentences read faster and translate more cleanly.
How do you shorten a long sentence?
Section titled “How do you shorten a long sentence?”Find a natural break, often where a conjunction like “and” or a “which” clause begins, and start a new sentence there.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00021 |
| Category | Sentences and phrases |
| Default severity | Suggestion |
| Enabled by default | No |
Ignore this rule
Section titled “Ignore this rule”To keep a long sentence on one line, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00021 -- quoted regulation text, preserve wording -->The regulation states that each provider must retain the records for seven years and make them available on request within thirty days of a written notice sent by the auditor.To disable the rule across your project, add it to the ignore list in your configuration file.