CliMA / CliMA/ClimaAnalysis.jl
Provide documentation on what is considered missing units
- Dominant language
- Julia
- Stars
- 12
- Forks
- 5
- Avg merge
- 7d 2h
- Merged PRs (30d)
- 2
Description
In ClimaAnalysis, if the attributes does not have "units" as a key or if the attributes does, but the value is the empty string, then the units returned by `units` is the empty string.
The documentation for `units` implies that the units is missing. This seems to be the behavior in the other ClimaAnalysis functions.
It would be nice to say this somewhere in the documentation.
Furthermore, this behavior differs from how `UDUnits.jl` parse units as the empty string is considered unitless and one can argue that if the units attribute is present, then the creators of the dataset intended for the units to be unitless. It may be worth it to update this behavior, but this would be considered a breaking change.
Contributor guide
No contributing guide indexed for this repository
Research direction
Find the documentation for the ClimaAnalysis `units` function and read its current description and nearby examples. Document that missing `units` attributes and empty-string values return an empty string, and clearly separate that behavior from the possible breaking change involving UDUnits.jl parsing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100