Renamed common API to Specific API

hgrecco · Oct 27, 2022 · 9eecc1f · 9eecc1f
1 parent cf3d431
commit 9eecc1f
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 4 deletions.
diff --git 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
@@ -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
@@ -6,5 +6,5 @@ API reference
     :hidden:
 
     base
-    common
+    specific
     facets
diff --git a/docs/api/common.rst → docs/api/specific.rst b/docs/api/common.rst → 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
@@ -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