Skip to content

Description documentation and examples are inconsistent #160

@WayneCrawford

Description

@WayneCrawford

The documentation of the "Description" element still gives non-recommended examples such as "Velocity in meters per second" and "Pascals". It should change from

Description of units, e.g. “Velocity in meters per second”, “Volts”, “Pascals”, “Degrees Celsius”. Description is only needed when the unit name is not a well know SI unit or there is need for clarification. Prefer not to use a Description for common units like m/s, m/s**2, count, etc.

to

Description of units, e.g. “Degrees Celsius”. Description is only needed when the unit name is not a well known SI unit or there is need for clarification. Prefer not to use a Description for common units like m/s, m/s**2, count, etc.

assuming that by "well-known SI units you mean the 7 base units plus the 22 derived units with special names and symbols" (Degrees Celsius is a problem because the symbol contains a non-ASCII character)

Also, non-recommended Descriptions are shown in the StationXML Response Examples. For example, for the "Broadband Sensor" you still have:

        <Response>
          <InstrumentSensitivity>
            <Value>941864732.693</Value>
            <Frequency>1.0</Frequency>
            <InputUnits>
              <Name>m/s</Name>
              <Description>Velocity in Meters per Second</Description>
            </InputUnits>
            <OutputUnits>
              <Name>count</Name>
              <Description>Digital Counts</Description>
            </OutputUnits>

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions