roland/xo-alloc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

xo-unit: streamline unit spec + docs

Browse source
This commit is contained in:
Roland Conybeare 2024-05-08 22:13:35 -04:00
commit 9f9d897dbf
5 changed files with 93 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/development.rst Normal file
View file

@ -0,0 +1,18 @@
.. _development:
Miscellaneous development notes for *xo-unit*.
How To...
=========
Add Basis Unit
--------------
To add a basis unit for an existing dimension:
#. add unit definition to the ``xo::qty::bu`` namespace in ``include/xo/unit/basis_unit.hpp``
#. add call to ``bu_store::bu_establish_abbrev()`` from ``bu_store::bu_store``.
#. add ``natural_unit`` definition to ``xo::qty::nu`` namespace in ``include/xo/unit/natural_unit.hpp``
#. add ``scaled_unit`` definition to ``xo::qty::u`` namespace in ``include/xo/unit/scaled_unit.hpp``.
#. add unit quantity to ``xo::qty::qty`` namespace in ``include/xo/unit/quantity.hpp``
#. add factory function to ``xo::qty::qty`` namespace in ``include/xo/unit/quantity.hpp``