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

Improve formatting documentation discoverability #123

Open
iliekturtles opened this issue Apr 10, 2019 · 3 comments
Open

Improve formatting documentation discoverability #123

iliekturtles opened this issue Apr 10, 2019 · 3 comments
Milestone

Comments

@iliekturtles
Copy link
Owner

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.

@Aehmlo
Copy link
Contributor

Aehmlo commented Apr 10, 2019

I can take care of this.

@iliekturtles
Copy link
Owner Author

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

@iliekturtles
Copy link
Owner Author

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 added a commit that referenced this issue Jul 29, 2020
mks and si examples are updated to use `format_args` or
`into_format_args` as appropriate so that the `Display` trait can be
used to display quantities in specific units. Part of #123.
iliekturtles added a commit that referenced this issue Aug 2, 2020
mks and si examples are updated to use `format_args` or
`into_format_args` as appropriate so that the `Display` trait can be
used to display quantities in specific units. Part of #123.
iliekturtles added a commit that referenced this issue Aug 3, 2020
mks and si examples are updated to use `format_args` or
`into_format_args` as appropriate so that the `Display` trait can be
used to display quantities in specific units. Part of #123.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants