update docstrings

xraypy · Dec 5, 2023 · a10517f · a10517f
1 parent 839bf02
commit a10517f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/python/xraydb/xray.py b/python/xraydb/xray.py
@@ -609,12 +609,13 @@ def core_width(element, edge=None):
         edge (None or str):  edge to consider
 
     Returns:
-        core width or list of core widths
+        a dict of ``{edge: core_hole_width}`` if the edge is not specified
+        or a float with the core hole width for a specified edge.
 
     Notes:
-       1. if edge is None, values are return for all edges
+       1. if edge is None, a dict of core hole widths for all edges is returned
        2. Data from Krause and Oliver (1979) and  Keski-Rahkonen and Krause (1974)
-
+       3. Values are in eV
     """
     xdb = get_xraydb()
     return xdb.corehole_width(element, edge=edge)

diff --git a/python/xraydb/xraydb.py b/python/xraydb/xraydb.py
@@ -646,8 +646,8 @@ def corehole_width(self, element, edge=None, use_keski=False):
             use_keski (bool) : force use of KeskiRahkonen and Krause table for all data.
 
         Returns:
-            either a dict of {edge: corehole_width} if the edge is not specified
-            or a float with the corehole width if the edge is specied
+            a dict of ``{edge: core_hole_width}`` if the edge is not specified
+            or a float with the core hole width for a specified edge.
 
         Notes:
             Uses Krause and Oliver where data is available (K, L lines Z > 10)