From 02302bbd9363facb59c4df2c1f4013087702cfa6 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Tue, 31 May 2022 15:36:40 -0700 Subject: Improve docstrings for sphinx. --- unittest_utils.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'unittest_utils.py') diff --git a/unittest_utils.py b/unittest_utils.py index 28b577e..a41aeb5 100644 --- 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 -- cgit v1.3