unitsofmeasurement / unit-api

Units of Measurement API
http://unitsofmeasurement.github.io/unit-api/
Other
182 stars 42 forks source link

57: Added definition for s (second) as per 9th Draft SI Brochure #168

Closed teobais closed 5 years ago

teobais commented 5 years ago

The way the equations are herewith represented is something I personally don't like that much (we're not in Latex unfortunately πŸ˜‚ ), but I would be interested in the views of the rest as well.


This change is Reviewable

desruisseaux commented 5 years ago

I would suggest to add some sentence saying that the definition of second in this javadoc is only informative. The normative part of JSR-385 specification could be the requirement to use SI definition (if we want to put that requirement - Werner, is it the case?). Then we can reproduce that definition in the comment for information purpose, but in case of doubt, typo or update from SI, the definition published by SI is normative. It could be just adding a sentence like: "This quantity is measured by a unit defined by SI as below (informative):". If the definition is copied from SI verbatim, then I suggest to put it in a HTML <blockquote> element, or any other way showing that we are quoting.

keilw commented 5 years ago

Where possible we should use the (new) SI definition.

teobais commented 5 years ago

So, we leave it as is (?) or am I missing something?

desruisseaux commented 5 years ago

I'm neutral on whether we leave it as is or not. My point was that if we want JSR-385 to be aligned on latest SI definition, then the javadoc should point to the SI definition and make clear that the copied text is only informative (i.e. that users should check the SI web site for most up-to-date definition).

teobais commented 5 years ago

Good point @desruisseaux . However, in order to avoid commits that might need to be changed before merging this, I would suggest that @keilw provides us with a specific direction.