forked from mpusz/mp-units
docs: admonition types usage fine tuned
This commit is contained in:
@@ -156,7 +156,7 @@ magnitudes. In that case, you may end up with a really small or a huge floating-
|
||||
in losing lots of precision. Returning a dimensionless quantity from such cases allows us to benefit from
|
||||
all the properties of scaled units and is consistent with the rest of the library.
|
||||
|
||||
!!! info
|
||||
!!! note
|
||||
|
||||
More information on the current design can be found in
|
||||
[the Dimensionless Quantities chapter](../users_guide/framework_basics/dimensionless_quantities.md).
|
||||
@@ -171,7 +171,7 @@ standards specify Unicode symbols as the official unit names for some quantities
|
||||
As **mp-units** library will be proposed for standardization as a part of the C++ Standard Library
|
||||
we have to obey the rules and be consistent with ISO specifications.
|
||||
|
||||
!!! info
|
||||
!!! note
|
||||
|
||||
We do understand engineering reality and the constraints of some environments. This is why the library
|
||||
has the option of ASCII-only Quantity Symbols.
|
||||
@@ -210,7 +210,7 @@ This is why our projects have two entry points:
|
||||
- _./src/CMakeLists.txt_ contains only a pure library definition and should be used by the customers
|
||||
that prefer to use CMake's `add_subdirectory()` to handle the dependencies.
|
||||
|
||||
!!! info
|
||||
!!! note
|
||||
|
||||
For more details on this please refer to the [CMake + Conan: 3 Years Later - Mateusz Pusz](https://youtu.be/mrSwJBJ-0z8?t=1931)
|
||||
lecture that Mateusz Pusz provided at the C++Now 2021 conference.
|
||||
|
||||
@@ -124,7 +124,7 @@ generators. For example:
|
||||
tools.cmake.cmaketoolchain:generator="Ninja Multi-Config"
|
||||
```
|
||||
|
||||
!!! note
|
||||
!!! info
|
||||
|
||||
_~/.conan2/global.conf_ file may also set `tools.cmake.cmake_layout:build_folder_vars` which
|
||||
[makes working with several compilers or build configurations easier](https://docs.conan.io/2/reference/tools/cmake/cmake_layout.html#multi-setting-option-cmake-layout).
|
||||
@@ -222,7 +222,7 @@ cmake .. -G "Ninja Multi-Config" -DCMAKE_TOOLCHAIN_FILE=<path_to_generators_dir>
|
||||
cmake --build . --config Release
|
||||
```
|
||||
|
||||
!!! note
|
||||
!!! tip
|
||||
|
||||
In case you can't use CMake 3.23 but you have access to CMake 3.20 or later, you can append
|
||||
`-c tools.cmake.cmaketoolchain.presets:max_schema_version=2` to the `conan install` command
|
||||
@@ -234,7 +234,7 @@ cmake --build . --config Release
|
||||
There are many different ways of installing/reusing **mp-units** in your project. Below we mention
|
||||
only a few of many options possible.
|
||||
|
||||
!!! info
|
||||
!!! important
|
||||
|
||||
The easiest and most recommended way to obtain **mp-units** is with the Conan package manager.
|
||||
See [Conan + CMake (release)](#conan-cmake-release) for a detailed instruction.
|
||||
|
||||
@@ -6,7 +6,7 @@ manipulation. The initial versions of the library were inspired by the
|
||||
but with each release, the interfaces diverged from the original to provide a better user
|
||||
experience.
|
||||
|
||||
!!! note
|
||||
!!! info
|
||||
|
||||
A brief introduction to the library's interfaces and the rationale for changes in the version 2.0
|
||||
of **mp-units** were provided in detail by [Mateusz Pusz](https://github.com/mpusz) in the
|
||||
@@ -36,7 +36,7 @@ To achieve this goal, several techniques are applied:
|
||||
- [usage of expression templates to improve the readability of generated types](../users_guide/framework_basics/interface_introduction.md#expression-templates),
|
||||
- limiting the number of template arguments to the bare minimum.
|
||||
|
||||
!!! note
|
||||
!!! important
|
||||
|
||||
In many generic C++ libraries compile-time errors do not happen often. It is hard to
|
||||
break `std::string` or `std::vector` in a way it won't compile with a huge error
|
||||
|
||||
@@ -33,7 +33,7 @@ using namespace mp_units::si::unit_symbols;
|
||||
quantity q = 42 * m;
|
||||
```
|
||||
|
||||
!!! note
|
||||
!!! tip
|
||||
|
||||
Unit symbols introduce a lot of short identifiers into the current namespace, and that is
|
||||
why they are opt-in. A user has to explicitly "import" them from a dedicated `unit_symbols`
|
||||
|
||||
Reference in New Issue
Block a user