Skip to content
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.

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

add unit recommendation from iris validator #76

Merged
merged 2 commits into from
Jan 19, 2022

Conversation

crotwell
Copy link
Collaborator

fix #73

Copy link

@pevans-gfz pevans-gfz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

75: stronly -> strongly

85: Don't start a sentence with abbreviations "E.g", "I.e" etc. So "...division is specified with '/'. For example ..."

87: More controversially, since we are being SI, meter->metre, at least in the documentation.

@crotwell
Copy link
Collaborator Author

Fixed the first two.

87: More controversially, since we are being SI, meter->metre, at least in the documentation.

Two thoughts on this. First "metre" is SI, but "meter" is very common in existing stationxml, so I am not sure if using metre in docs adds to confusion or not.

Second, I would prefer to sidestep the language issues completely by preferring SI symbols to names. So perhaps add:

SI symbols are preferred over names to avoid language differences, for example `m/s` is preferred over "meter/second" or "metre/second"

But given how much existing stationxml exists with unit names, this may also be controversial.

@pevans-gfz
Copy link

Your wording there (m/s is preferred over "meter/second") makes great sense to me, and is in line with your earlier #51.

@jschaeff
Copy link
Contributor

jschaeff commented Jan 5, 2022

I'm in favor of m/s wich is clearly consistent with the international system of units https://en.wikipedia.org/wiki/International_System_of_Units

And it should appear in the unit recommandations.

As it is "only" a recommandation, it's OK to push best practices, it won't force anyone to change the existing.

@crotwell crotwell merged commit a13c547 into FDSN:doc_issues Jan 19, 2022
@crotwell crotwell deleted the unit_naming_rules branch January 19, 2022 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants