uom icon indicating copy to clipboard operation
uom copied to clipboard

Improve formatting documentation discoverability

Open iliekturtles opened this issue 5 years ago • 3 comments

Currently you need to know to dig all the way into one of the quantity type aliases (e.g. Acceleration) or view the documentation for one of the types in the uom::si::fmt module (e.g. Arguments). Add additional module level to uom::fmt and uom::si::fmt (verify this doesn't break generated code for systems besides si) as well as update uom::fmt::DisplayStyle to include an example or explicitly link to one of the above locations.

iliekturtles avatar Apr 10 '19 00:04 iliekturtles

I can take care of this.

Aehmlo avatar Apr 10 '19 02:04 Aehmlo

Make sure it is explicitly noted that std::fmt specifiers can be used.

iliekturtles avatar Jul 15 '19 14:07 iliekturtles

Per #195, in addition to making formatting documentation more visible also note the differences between formatting and get(). Also update examples to use formatting methods where appropriate.

iliekturtles avatar Jul 15 '20 14:07 iliekturtles