summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHernan <hernan.grecco@gmail.com>2022-05-01 14:06:28 -0300
committerHernan <hernan.grecco@gmail.com>2022-05-01 14:06:54 -0300
commite0f14124fa8d3ef3256d590a9fceb4cd79185ecc (patch)
tree4b3ef97983a836ec6bbd6077ed7bfbdb2a578da9
parent430c4aa71e304ba1cc5f5ed1fdfaceed936f7c72 (diff)
downloadpint-e0f14124fa8d3ef3256d590a9fceb4cd79185ecc.tar.gz
Adjust docstrings
-rw-r--r--pint/registry.py31
1 files changed, 5 insertions, 26 deletions
diff --git a/pint/registry.py b/pint/registry.py
index 98a716c..80f5ec4 100644
--- a/pint/registry.py
+++ b/pint/registry.py
@@ -2,34 +2,13 @@
pint.registry
~~~~~~~~~~~~~
- Defines the Registry, a class to contain units and their relations.
+ Defines the UnitRegistry, a class to contain units and their relations.
- The facet_module actually defines 5 registries with different capabilities:
+ This registry contains all pint capabilities, but you can build your
+ customized registry by picking only the features that you actually
+ need.
- - PlainRegistry: Basic unit definition and querying.
- Conversion between multiplicative units.
-
- - NonMultiplicativeRegistry: Conversion between non multiplicative (offset) units.
- (e.g. Temperature)
-
- * Inherits from PlainRegistry
-
- - ContextRegisty: Conversion between units with different dimensions according
- to previously established relations (contexts) - e.g. in spectroscopy,
- conversion between frequency and energy is possible. May also override
- conversions between units on the same dimension - e.g. different
- rounding conventions.
-
- * Inherits from PlainRegistry
-
- - SystemRegistry: Group unit and changing of plain units.
- (e.g. in MKS, meter, kilogram and second are plain units.)
-
- * Inherits from PlainRegistry
-
- - UnitRegistry: Combine all previous capabilities, it is exposed by Pint.
-
- :copyright: 2016 by Pint Authors, see AUTHORS for more details.
+ :copyright: 2022 by Pint Authors, see AUTHORS for more details.
:license: BSD, see LICENSE for more details.
"""