Avoid gender-specific pronouns (EK00014)
Singular they covers any reader in one word, keeping your documentation short and inclusive for everyone.
Singular “they” covers any reader in a single word, which keeps instructions short and easy to follow. EkLine flags paired pronoun constructions such as he/she and s/he and suggests “they” instead (rule EK00014).
Why use singular they in documentation?
Section titled “Why use singular they in documentation?”Constructions like “he/she” and “(s)he” force the reader to parse two forms where one works. Singular “they” reads smoothly, applies to every reader, and avoids the awkward slash. It also translates more cleanly, because many languages have no direct equivalent for the paired English form.
What EkLine flags
Section titled “What EkLine flags”EK00014 matches gendered pronoun constructions, including “he/she”, “s/he”, and “(s)he”.
- ❌ Incorrect: Ask the user for his/her token.
- ✅ Correct: Ask the user for their token.
- ❌ Incorrect: Once verified, s/he can log in.
- ✅ Correct: Once verified, they can log in.
How to fix
Section titled “How to fix”Replace the flagged construction with “they”, “their”, or “them”, and adjust the surrounding verb if needed.
Is singular they grammatically correct?
Section titled “Is singular they grammatically correct?”Yes. Singular “they” is well established in English, and most modern style guides accept it when you refer to an unspecified person.
When should you use a specific pronoun instead of they?
Section titled “When should you use a specific pronoun instead of they?”Use a specific pronoun when you refer to a named person whose pronoun is known. Everywhere the reader is unspecified, “they” applies.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00014 |
| Category | Inclusive language |
| Default severity | Error |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep a flagged construction on one line, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00014 -- direct quotation, preserve original -->The report states, "Each analyst submits his/her findings weekly."To disable the rule across your project, add it to the ignore list in your configuration file.