Format data measurements consistently (EK00054)
Consistent data measurements like 8 GB keep documentation readable. Learn how to format storage and frequency units with a numeral and a space.
A consistent data measurement pairs a numeral, a space, and the unit, such as 8 GB, so values read the same across your documentation. EkLine flags data-storage and frequency units written without a numeral or without a space (rule EK00054) and suggests the standard format.
How do you format data measurements in documentation?
Section titled “How do you format data measurements in documentation?”Data measurements appear throughout technical documentation, and inconsistent formatting makes them harder to scan. Writing 8GB on one page and 8 GB on another looks unedited, and spelling the number out as eight GB slows readers who expect a numeral. A numeral, a space, and the unit gives you one predictable format for every storage and frequency value.
What EkLine flags
Section titled “What EkLine flags”EK00054 matches data-storage and frequency units — such as KB, MB, GB, and GHz — written without a numeral or without a space between the number and the unit.
- ❌ Incorrect: The image is 8GB.
- ✅ Correct: The image is 8 GB.
- ❌ Incorrect: Allocate eight GB of memory.
- ✅ Correct: Allocate 8 GB of memory.
How to fix
Section titled “How to fix”Write the value as a numeral, a space, and the unit, such as 8 GB or 2 GHz.
How do you write a data-storage measurement?
Section titled “How do you write a data-storage measurement?”Write a numeral, a space, and the unit, such as 8 GB or 2 GHz. Avoid spelling the number out or closing the space, as in 8GB.
Why keep measurement formatting consistent?
Section titled “Why keep measurement formatting consistent?”A single format lets readers scan storage and frequency values quickly and keeps your documentation looking edited.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00054 |
| Category | Consistency |
| Default severity | Warning |
| Enabled by default | No |
Ignore this rule
Section titled “Ignore this rule”To keep a data measurement’s formatting on one line, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00054 -- matches the product's model name -->The 8GB edition ships today.To disable the rule across your project, add it to the ignore list in your configuration file.