diff options
| author | Hernan <hernan.grecco@gmail.com> | 2022-10-27 09:16:12 -0300 |
|---|---|---|
| committer | Hernan <hernan.grecco@gmail.com> | 2022-10-27 09:16:12 -0300 |
| commit | 9eecc1fc105b0d137fe878a4a20e8c1e8ed5e036 (patch) | |
| tree | 86e3ac7da94fef52a08a569b1b0a300f5dbee86e /docs | |
| parent | cf3d431f852071364ca5a24b82db595d240bb927 (diff) | |
| download | pint-9eecc1fc105b0d137fe878a4a20e8c1e8ed5e036.tar.gz | |
Renamed common API to Specific API
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/base.rst | 3 | ||||
| -rw-r--r-- | docs/api/facets.rst | 6 | ||||
| -rw-r--r-- | docs/api/index.rst | 2 | ||||
| -rw-r--r-- | docs/api/specific.rst (renamed from docs/api/common.rst) | 8 | ||||
| -rw-r--r-- | docs/getting/tutorial.rst | 2 |
5 files changed, 17 insertions, 4 deletions
diff --git a/docs/api/base.rst b/docs/api/base.rst index cd28a5f..c060cac 100644 --- a/docs/api/base.rst +++ b/docs/api/base.rst @@ -5,6 +5,9 @@ Base API .. currentmodule:: pint +These are the classes, exceptions and functions that you will most likely use. + + Most important classes ---------------------- diff --git a/docs/api/facets.rst b/docs/api/facets.rst index a40b4a1..f4b6a54 100644 --- a/docs/api/facets.rst +++ b/docs/api/facets.rst @@ -1,6 +1,12 @@ API facets reference ==================== +Registry functionality is divided into facet. Each provides classes and functions +specific to a particular purpose. They expose at least a Registry, and in certain +cases also a Quantity, Unit and other objects. + +The default UnitRegistry inherits from all of them. + .. automodule:: pint.facets.plain :members: diff --git a/docs/api/index.rst b/docs/api/index.rst index 5975c5b..212a02d 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -6,5 +6,5 @@ API reference :hidden: base - common + specific facets diff --git a/docs/api/common.rst b/docs/api/specific.rst index da4ab70..f0343c1 100644 --- a/docs/api/common.rst +++ b/docs/api/specific.rst @@ -1,5 +1,9 @@ -Common API -========== +Specific API +============ + +These are the classes, exceptions and functions that you will use if you need +to dig deeper into Pint or develop Pint. + .. automodule:: pint.babel_names :members: diff --git a/docs/getting/tutorial.rst b/docs/getting/tutorial.rst index 0889355..04d5a42 100644 --- a/docs/getting/tutorial.rst +++ b/docs/getting/tutorial.rst @@ -85,7 +85,7 @@ Pint will complain if you try to use a unit which is not in the registry: You can add your own units to the existing registry, or build your own list. See the page on :ref:`defining` for more information on that. -See `String parsing`_ and :doc:`defining-quantities` for more ways of defining +See `String parsing`_ and :ref:`Defining Quantities`_ for more ways of defining a ``Quantity()`` object. ``Quantity()`` objects also work well with NumPy arrays, which you can |