Prefer English terms over Latin abbreviations (EK00026)
Plain English instead of Latin abbreviations like e.g. or i.e. keeps documentation clear for every reader. Learn why, with examples and fixes.
Plain English phrases such as “for example” and “that is” read clearly for every audience, including readers who don’t know Latin abbreviations like “e.g.” or “i.e.” EkLine flags these Latin abbreviations and suggests a plain English equivalent (rule EK00026).
Why avoid Latin abbreviations in documentation?
Section titled “Why avoid Latin abbreviations in documentation?”Readers often confuse “e.g.” (for example) with “i.e.” (that is), and a mix-up changes the meaning of a sentence. Latin abbreviations also trip up non-native English speakers and screen readers, which spell them out letter by letter. Plain English equivalents carry the same meaning without the guesswork.
What EkLine flags
Section titled “What EkLine flags”EK00026 matches Latin abbreviations such as “e.g.”, “i.e.”, “viz.”, and “ergo”, and suggests the English equivalents “for example”, “that is”, “namely”, and “therefore”.
- ❌ Incorrect: Use a structured format, e.g. JSON.
- ✅ Correct: Use a structured format, for example, JSON.
- ❌ Incorrect: Set the timeout to 0, i.e. the default value.
- ✅ Correct: Set the timeout to 0, that is, the default value.
How to fix
Section titled “How to fix”Replace the Latin abbreviation with its English equivalent: “for example” for “e.g.”, “that is” for “i.e.”, “namely” for “viz.”, and “therefore” for “ergo”.
What does “e.g.” mean, and what should you use instead?
Section titled “What does “e.g.” mean, and what should you use instead?”“e.g.” means “for example”. Write “for example” in your documentation so every reader understands the sentence without translating the Latin.
What is the difference between “e.g.” and “i.e.”?
Section titled “What is the difference between “e.g.” and “i.e.”?”“e.g.” introduces examples, and “i.e.” restates something exactly. Spelling both out as “for example” and “that is” removes the common mix-up between them.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00026 |
| Category | Consistency |
| Default severity | Error |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep a Latin abbreviation on one line, add an inline comment:
<!-- ekline-ignore-next-line EK00026 -- Latin term quoted from the spec -->The clause uses the phrase "i.e." verbatim.To disable the rule across your project, add it to the ignore list in your configuration file.