DOC #326 titles, advice, substitutions

bluesky · May 1, 2024 · 5a3b67e · 5a3b67e
1 parent 6f038d0
commit 5a3b67e
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/docs/source/examples/diffractometer.rst b/docs/source/examples/diffractometer.rst
@@ -2,8 +2,8 @@
 
 .. _examples.diffractometer:
 
-Diffractometer Geometries
--------------------------
+Diffractometer Examples
+-----------------------
 
 See also the documentation for the :ref:`geometries` module.
 

diff --git a/docs/source/geometry_tables.rst b/docs/source/geometry_tables.rst
@@ -22,7 +22,7 @@ Geometries indexed by number of circles
 The different diffractometer geometries are distinguished, primarily, by
 the number of axes (circles) and the names of each.  This table is
 sorted first by the number of circles, and then the geometry name (as
-used here in *hklpy*).
+used here in |hklpy|).
 
 
 ======== ================================================================ =======================================================================

diff --git a/hkl/geometries.py b/hkl/geometries.py
@@ -183,7 +183,15 @@ class Zaxis(Diffractometer):
 
 
 class SimMixin(Device):
-    """Defines `h`, `k`, & `l` pseudo-positioners."""
+    """
+    Defines `h`, `k`, & `l` pseudo-positioners.
+
+    Use this mixin class with any of the diffractometer geometries to create
+    your own simulator.  Follow one of the simulators below, such as
+    :class:`~hkl.geometries.SimulatedE4CV`.  You should replace ``E4CV`` with
+    your geomtry's name.  And, you will need to create SoftPositioner components
+    for each of the real-space axes, in the order required by that geometry.
+    """
 
     h = Cpt(PseudoSingle, "", kind="hinted")
     k = Cpt(PseudoSingle, "", kind="hinted")

diff --git a/hkl/user.py b/hkl/user.py
@@ -1,5 +1,5 @@
 """
-Provide a simplified interface for hklpy diffractometer users.
+Provide a simplified interface for |hklpy| diffractometer users.
 
 The user must define a diffractometer instance, then
 register that instance here calling ``select_diffractometer(instance)``.