Capitalize unit abbreviations correctly (EK00056)
Correct unit casing like GHz and KiB keeps documentation accurate. Learn how to capitalize frequency and binary data-size abbreviations.
Unit abbreviations carry meaning in their casing, so GHz for frequency and KiB for binary data sizes keep your documentation accurate. EkLine flags unit abbreviations that use incorrect capitalization (rule EK00056) and suggests the correct form.
Why does unit capitalization matter in documentation?
Section titled “Why does unit capitalization matter in documentation?”Unit abbreviations carry meaning in their casing: GHz names a frequency, and KiB names a binary data size distinct from KB. When capitalization drifts to ghz or KIB, the unit looks unedited and can confuse readers who rely on the exact form. Correct casing keeps your measurements accurate and consistent with the standards your readers expect.
What EkLine flags
Section titled “What EkLine flags”EK00056 matches unit abbreviations for frequency and binary data sizes that use incorrect capitalization and suggests the correct form.
- ❌ Incorrect: The processor runs at 2 ghz.
- ✅ Correct: The processor runs at 2 GHz.
- ❌ Incorrect: Reserve 512 KIB for the buffer.
- ✅ Correct: Reserve 512 KiB for the buffer.
How to fix
Section titled “How to fix”Write the unit with its standard capitalization, such as GHz for frequency or KiB for binary data sizes.
How do you capitalize GHz and KiB?
Section titled “How do you capitalize GHz and KiB?”Write frequency as GHz and binary data sizes as KiB, with the exact casing each standard defines. Forms like ghz or KIB are incorrect.
Why does the casing of a unit matter?
Section titled “Why does the casing of a unit matter?”Casing distinguishes units: KiB names a binary size separate from KB. Wrong casing can confuse readers who rely on the exact form.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK00056 |
| Category | Consistency |
| Default severity | Warning |
| Enabled by default | No |
Ignore this rule
Section titled “Ignore this rule”To keep a unit’s capitalization on one line, add an inline comment with a reason:
<!-- ekline-ignore-next-line EK00056 -- matches the log output verbatim -->The device reports "2 ghz" in its status line.To disable the rule across your project, add it to the ignore list in your configuration file.