Improve docstrings for sphinx.

[python_utils.git] / unittest_utils.py

diff --git a/unittest_utils.py b/unittest_utils.py
index 28b577e2086af4ff20647d05cd9be24761839d6d..a41aeb5d02108b7cd836cd0c9972262b114d0b76 100644 (file)
--- a/unittest_utils.py
+++ b/unittest_utils.py
@@ -2,11 +2,14 @@
 
 # © Copyright 2021-2022, Scott Gasch
 
-"""Helpers for unittests.  Note that when you import this we
-automatically wrap unittest.main() with a call to bootstrap.initialize
-so that we getLogger config, commandline args, logging control,
-etc... this works fine but it's a little hacky so caveat emptor.
+"""Helpers for unittests.
 
+.. note::
+
+    When you import this we automatically wrap unittest.main()
+    with a call to bootstrap.initialize so that we getLogger
+    config, commandline args, logging control, etc... this works
+    fine but it's a little hacky so caveat emptor.
 """
 
 import contextlib