diff --git a/docs/design/quantity.rst b/docs/design/quantity.rst index a4695c44..a027d62a 100644 --- a/docs/design/quantity.rst +++ b/docs/design/quantity.rst @@ -56,12 +56,12 @@ Beside adding new elements a few other changes where applied compared to the `std::chrono::duration `_ class template: -1. The ``duration`` is using ``std::common_type_t`` to find a common +1. The ``std::chrono::duration`` is using ``std::common_type_t`` to find a common representation for a calculation result. Such a design was reported as problematic by SG6 (numerics study group) members as sometimes we want to provide a different type in case of multiplication and different in case of division. ``std::common_type`` - lacks that additional information. That is why `units::quantity` uses the resulting + lacks that additional information. That is why `quantity` uses the resulting type of a concrete operator operation. -2. `operator %` is constrained with `treat_as_floating_point` type trait to limit the - types to integral representations only. Also `operator %(Rep)` takes `Rep` as a +2. ``quantity::operator%()`` is constrained with `treat_as_floating_point` type trait to limit the + types to integral representations only. Also ``quantity::operator%(Rep)`` takes ``Rep`` as a template argument to limit implicit conversions. diff --git a/docs/framework/dimensions.rst b/docs/framework/dimensions.rst index d1c24e4b..017a8b3a 100644 --- a/docs/framework/dimensions.rst +++ b/docs/framework/dimensions.rst @@ -118,7 +118,7 @@ provided. For example the SI base dimension of length can be defined as:: } In the above code sample ``"L"`` is an base dimension's unique identifier -and `si::metre` is a :term:`base unit` of this base dimension. We can +and `physical::si::metre` is a :term:`base unit` of this base dimension. We can obtain those back easily with:: static_assert(si::dim_length::symbol == "L"); @@ -153,9 +153,9 @@ The above dimensions can be defined in the library with the } -In the above code sample `si::square_metre` and `si::metre_per_second` -are the :term:`coherent derived units ` of those -derived dimensions. +In the above code sample `physical::si::square_metre` and +`physical::si::metre_per_second` are the +:term:`coherent derived units ` of those derived dimensions. Coherent unit argument is followed by the list of exponents that form this derived dimension. This list is called a :term:`recipe` of this derived diff --git a/docs/usage.rst b/docs/usage.rst index 8192732e..a24e5eb3 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -18,7 +18,7 @@ This repository contains three independent CMake-based projects: but until then it depends on: - `{fmt} `_ to provide text formatting of quantities. - - `ms-gsl `_ to verify runtime contracts with `Expects` macro. + - `ms-gsl `_ to verify runtime contracts with ``Expects`` macro. - *.* @@ -155,7 +155,7 @@ defined by the library. To do so you should use *CMakeLists.txt* file from the * .. code-block:: cmake add_subdirectory(/src) - ... + # ... target_link_libraries( PUBLIC|PRIVATE|INTERFACE mp-units::mp-units) .. important::