feedc0de/mp-units
1
0
Fork 0
forked from mpusz/mp-units
Code Pull Requests Activity

docs: "Default formatting" chapter updated

Browse Source
This commit is contained in:
Mateusz Pusz
2023-11-30 09:59:55 +01:00
parent c002a7487a
commit ea62c74b88
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/users_guide/framework_basics/text_output.md
View File

@@ -146,9 +146,9 @@ In the above grammar:
### Default formatting ### Default formatting
To format `quantity` values the formatting facility uses `units-format-spec`. If it is left empty, To format `quantity` values, the formatting facility uses `units-format-spec`. If left empty,
the default formatting of `{:%Q %q}` is applied. The same default formatting is also applied the default formatting is applied. The same default formatting is also applied to the output streams.
to the output streams. This is why the following code lines produce the same output: This is why the following code lines produce the same output:
```cpp ```cpp
std::cout << "Distance: " << 123 * km << "\n"; std::cout << "Distance: " << 123 * km << "\n";
@@ -156,6 +156,15 @@ std::cout << std::format("Distance: {}\n", 123 * km);
std::cout << std::format("Distance: {:%Q %q}\n", 123 * km); std::cout << std::format("Distance: {:%Q %q}\n", 123 * km);
``` ```
!!! note
For some quantities the `{:%Q %q}` format may provide a different output than the default one.
It will happen for example for:
- units for which [`space_before_unit_symbol`](#customization-point) customization point is set
to `false`,
- quantities of dimension one with a unit one.
### Controlling width, fill, and alignment ### Controlling width, fill, and alignment