Skip to content

docs: clarify unit field usage in common metadata #1373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 18, 2025
Merged

docs: clarify unit field usage in common metadata #1373

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions commons/common-metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,10 @@ It is STRONGLY RECOMMENDED to provide units in one of the following two formats:
- [UCUM](https://ucum.org/): The unit code that is compliant to the UCUM specification.
- [UDUNITS-2](https://ncics.org/portfolio/other-resources/udunits2/): The unit symbol if available, otherwise the singular unit name.

To specify that a value is unitless (dimensionless), provide an empty string (`""`).
If unit information is not available or not applicable, the `unit` field SHOULD be omitted entirely.
The value `null` is not valid for this field.

### Statistics Object

Statistics usually specify the range of values by providing the `minimum` and `maximum` values,
Expand Down