search

bjornbm / dimensional

Dimensional library variant built on Data Kinds, Closed Type Families, TypeNats (GHC 7.8+).
BSD 3-Clause "New" or "Revised" License
102 stars 15 forks source link

Add doc comments for SI prefixes & rename "deka" to "deca" #216

Closed konsumlamm closed 2 years ago

konsumlamm commented 2 years ago

Add some missing doc comments.

As for "deca" vs "deka": According to Wikipedia, the international spelling is "deca", while "deka" is the american spelling (so exactly the opposite of what was claimed here). Also, the SI Brochure only mentions "deca". I thus changed the deka Prefix to deca and changed the full name.

bjornbm commented 2 years ago

Thanks for the documentation! And for the deka -> deca change, I have no skin in the game so fine for me (and you are right the spelling comment was wrong!). @dmcclean, do you care? At the user-facing (non-internal) level both are available just as before.

For background, the library was built largely around NIST SP811, which say in appendix C:

the spelling of English-language words - for example, "meter," "liter," and "deka" are used instead of "metre," "litre," and "deca" - is in accordance with the United States Government Printing Office Style Manual [3], which follows Webster's Third New International Dictionary rather than the Oxford Dictionary used in many English-speaking countries. This spelling also reflects recommended United States practice (see Secs. C.1 and C.5);