mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-08-04 20:54:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: "No text output for points" chapter added

Browse Source
This commit is contained in:
Mateusz Pusz
2023-08-04 14:35:20 +02:00
parent 4c49e9c57f
commit 53c9d96e9e
2 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -5,12 +5,12 @@ any quantity in the most user-friendly way.
!!! note !!! note
The library provides no text output for quantity points, as printing just a number and a unit The library does not provide a text output for quantity points, as printing just a number and a unit
is not enough to adequately describe a quantity point. Often an additional postfix is required. is not enough to adequately describe a quantity point. Often an additional postfix is required.
For example, the text output of `42 m` may mean many things and can also be confused with
an output of a regular quantity. On the other hand, printing `42 m AMSL` for altitudes above For example, the text output of `42 m` may mean many things and can also be confused with an output
mean sea level is a much better solution, but the library does not have enough information of a regular quantity. On the other hand, printing `42 m AMSL` for altitudes above mean sea level is
to print it that way. a much better solution, but the library does not have enough information to print it that way by itself.
## Output Streams ## Output Streams

10
docs/users_guide/framework_basics/the_affine_space.md
View File

@@ -302,6 +302,16 @@ Highest temp: 3 °C (24 °C)
``` ```
### No text output for _points_
The library does not provide a text output for quantity points, as printing just a number and a unit
is not enough to adequately describe a quantity point. Often an additional postfix is required.
For example, the text output of `42 m` may mean many things and can also be confused with an output
of a regular quantity. On the other hand, printing `42 m AMSL` for altitudes above mean sea level is
a much better solution, but the library does not have enough information to print it that way by itself.
## The affine space is about type-safety ## The affine space is about type-safety
The following operations are not allowed in the affine space: The following operations are not allowed in the affine space: