Spell out month names in dates (EK00046)
Spelling out the month name makes dates unambiguous across regions. Write July 31, 2024 rather than 07/31/2024 in your documentation.
Spelling out the month name — July 31, 2024 rather than 07/31/2024 — makes a date clear to every reader, whatever their region. EkLine flags dates that use a number for the month (rule EK00046) and suggests writing out the month name.
Why spell out month names in documentation dates?
Section titled “Why spell out month names in documentation dates?”All-numeric dates are ambiguous across regions: 07/08/2024 reads as July 8 to some readers and August 7 to others. Spelling out the month removes that ambiguity and makes dates readable at a glance. A consistent, written-out month also matches the format most documentation style guides recommend.
What EkLine flags
Section titled “What EkLine flags”EK00046 detects a date written with a numeric month, such as the MM/DD/YYYY format.
- ❌ Incorrect: The trial ends on 07/31/2024.
- ✅ Correct: The trial ends on July 31, 2024.
- ❌ Incorrect: Support ended 12/25/2023.
- ✅ Correct: Support ended December 25, 2023.
How to fix
Section titled “How to fix”Rewrite the date with the full month name, the day, and the year.
Why are all-numeric dates ambiguous?
Section titled “Why are all-numeric dates ambiguous?”A date like 07/08/2024 reads as July 8 to some readers and August 7 to others. Spelling out the month removes that ambiguity and makes the date readable at a glance.
How should you write a date instead?
Section titled “How should you write a date instead?”Write the full month name, the day, and the year — for example, July 31, 2024. For the full date convention EkLine recommends, see EK00008.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00046 |
| Category | Sentences and phrases |
| Default severity | Error |
| Enabled by default | Yes |
Ignore this rule
Section titled “Ignore this rule”To keep a numeric date on one line, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00046 -- matches the log timestamp format -->The entry is dated 07/31/2024.To disable the rule across your project, add it to the ignore list in your configuration file.