Chapter titles casing unified

This commit is contained in:
Mateusz Pusz
2020-03-26 17:09:26 +01:00
parent d8d3dcf339
commit 89c8c58073
7 changed files with 21 additions and 21 deletions

View File

@@ -15,7 +15,7 @@ The library tries to follow the above principle and at the same time is also con
with conversions of ``std::chrono::duration``.
No conversions
No Conversions
--------------
No conversions (either implicit or explicit) are available across quantities of

View File

@@ -62,7 +62,7 @@ dimension, than we will end up with just a scalar type:
Scalar auto v2 = dur1 * fr1; // 50
Base dimensions
Base Dimensions
---------------
The quantities of base dimensions are called
@@ -88,7 +88,7 @@ obtain those back easily with::
static_assert(std::is_same_v<si::dim_length::base_unit, si::metre>);
Derived dimensions
Derived Dimensions
------------------
The quantities of derived dimensions are called

View File

@@ -59,7 +59,7 @@ language (i.e. ``F`` (farad), ``J`` (joule), ``W`` (watt), ``K`` (kelvin),
``q_`` prefix was consistently applied to all the UDLs.
Dimension-specific concepts
Dimension-specific Concepts
---------------------------
In case the user does not care about the specific unit and representation but
@@ -130,7 +130,7 @@ units like CGS.
kinds of interfaces supported by the library.
Working with constrained deduced quantity types
Working With Constrained Deduced Quantity Types
-----------------------------------------------
It is important to note that when we assign a result from the function to an

View File

@@ -1,12 +1,12 @@
.. namespace:: units
Text output
Text Output
===========
Beside providing dimensional analysis and units conversions, the library
also tries really hard to print any quantity in the most user friendly way.
Output streams
Output Streams
--------------
The easiest way to print a quantity is to provide its object to the output
@@ -31,7 +31,7 @@ by a space and then the symbol of a :term:`unit` associated with this quantity.
std::cout << quantity_cast<si::metre_per_second>(v1) << '\n'; // 30.5556 m/s
Stream output formatting
Stream Output Formatting
^^^^^^^^^^^^^^^^^^^^^^^^
Only a basic formatting can be applied for output streams. It includes control
@@ -92,7 +92,7 @@ code lines produce the same output::
fmt::print("Distance: {:%Q %q}\n", 123q_km);
Quantity value, symbol, or both?
Quantity Value, Symbol, or Both?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The user can easily decide to either print a whole quantity (value and symbol) or
@@ -103,7 +103,7 @@ only its parts. Also a different quantity formatting might be applied::
fmt::print("{:%Q%q}", 123q_km); // 123km
Controlling width, fill, and alignment
Controlling Width, Fill, and Alignment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To control width, fill, and alignment the C++ standard grammar tokens ``fill-and-align``
@@ -120,7 +120,7 @@ text::
fmt::print("|{:*^10}|", 123q_m); // |**123 m***|
ASCII-only quantity symbols
ASCII-only Quantity Symbols
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Unit symbols of some quantities are specified to use Unicode signs by the :term:`SI`
@@ -137,7 +137,7 @@ In such a case the unit symbol can be forced to be printed using ASCII-only char
fmt::print("{:%Q %Aq}", 9.8q_m_per_s2); // 9.8 m/s^2
Controlling on how the quantity value is being printed
Controlling on How the Quantity Value Is Being Printed
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
``sign`` token allows us to specify on how the value's sign is being printed::
@@ -198,7 +198,7 @@ For floating-point values the :token:`units-rep-type` token works as follows::
fmt::print("{:%.3GQ %q}", 1.2345678e8q_m); // 1.23E+08 m
Special signs
Special Signs
^^^^^^^^^^^^^
Beside adding any list of regular characters as a separator between the value and the

View File

@@ -308,7 +308,7 @@ provided in the template parameter list after the derived dimension parameter,
the library calculates the final ratio for this unit.
Class hierarchy
Class Hierarchy
---------------
All of the above class templates to produce unit types inherit from some instance

View File

@@ -6,7 +6,7 @@ Usage
As this library targets C++23 and extensively uses C++20 features as of now it compiles correctly
only with gcc-9.1 and newer.
Repository structure and dependencies
Repository Structure and Dependencies
-------------------------------------
This repository contains three independent CMake-based projects:
@@ -58,7 +58,7 @@ The rest of the dependencies are provided by :command:`python3-pip`.
A full list of dependencies can be found in `Repository structure and dependencies`_.
Conan quick intro
Conan Quick Intro
^^^^^^^^^^^^^^^^^
In case you are not familiar with Conan, to install it (or upgrade) just do:
@@ -114,10 +114,10 @@ Add the following remotes to your local Conan instance:
in **mp-units** repository.
Build options
Build Options
-------------
Environment variables
Environment Variables
^^^^^^^^^^^^^^^^^^^^^
.. envvar:: CONAN_RUN_TESTS
@@ -194,7 +194,7 @@ To use **mp-units** as a CMake imported library the following steps may be perfo
6. Configure your CMake project as usual.
Full **mp-units** build, unit testing, and documentation generation
Full **mp-units** Build, Unit Testing, and Documentation Generation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In case you would like to build all the source code (with unit tests and examples) and documentation
@@ -229,7 +229,7 @@ To test CMake installation and Conan packaging or create a Conan package run:
The above will create a Conan package and run tests provided in *./test_package* directory.
Uploading **mp-units** package to the Conan server
Uploading **mp-units** Package to the Conan Server
--------------------------------------------------
.. code-block:: shell

View File

@@ -1,6 +1,6 @@
.. namespace:: units
Extending the library
Extending the Library
=====================
Custom Units