docs(utils): generate entries of submodule *utils*

BAMresearch · Feb 24, 2023 · 762a548 · 762a548
1 parent 738fdd4
commit 762a548
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/reference/jupyter_analysis_tools.utils.rst b/docs/reference/jupyter_analysis_tools.utils.rst
@@ -0,0 +1,5 @@
+jupyter_analysis_tools.utils
+============================
+
+.. automodule:: jupyter_analysis_tools.utils
+    :members:
diff --git a/src/jupyter_analysis_tools/utils.py b/src/jupyter_analysis_tools/utils.py
@@ -44,6 +44,7 @@ def isWindows():
 def isList(obj):
     """Return true if the provided object is list-like including a numpy array
     but not a string.
+
     >>> isList([1, 2, 'a'])
     True
     >>> isList(tuple((1, 2, 'a')))
@@ -153,7 +154,7 @@ def fmtErr(val, std, precision=2, width=None):
 
 
 def updatedDict(d, key, value):
-    """Implements the |= operator for dict in Python version <3.9."""
+    """Implements the \\|= operator for dict in Python version <3.9."""
     dd = copy.copy(d)
     dd[key] = value
     return dd