From 53c9d96e9e37238ff287b92744819bd951914d73 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Fri, 4 Aug 2023 14:35:20 +0200 Subject: [PATCH] docs: "No text output for points" chapter added --- docs/users_guide/framework_basics/text_output.md | 10 +++++----- docs/users_guide/framework_basics/the_affine_space.md | 10 ++++++++++ 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/users_guide/framework_basics/text_output.md b/docs/users_guide/framework_basics/text_output.md index 0c2bf168..34623dbc 100644 --- a/docs/users_guide/framework_basics/text_output.md +++ b/docs/users_guide/framework_basics/text_output.md @@ -5,12 +5,12 @@ any quantity in the most user-friendly way. !!! 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. - 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. + + 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. ## Output Streams diff --git a/docs/users_guide/framework_basics/the_affine_space.md b/docs/users_guide/framework_basics/the_affine_space.md index 9189769a..0b1411c2 100644 --- a/docs/users_guide/framework_basics/the_affine_space.md +++ b/docs/users_guide/framework_basics/the_affine_space.md @@ -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 following operations are not allowed in the affine space: