diff options
| author | Scott Gasch <[email protected]> | 2022-05-31 15:36:40 -0700 |
|---|---|---|
| committer | Scott Gasch <[email protected]> | 2022-05-31 15:36:40 -0700 |
| commit | 02302bbd9363facb59c4df2c1f4013087702cfa6 (patch) | |
| tree | 938e51338678416afc891d2839c2ee8dd341f34d /unittest_utils.py | |
| parent | f3dbc7dc19ba5703f8f5aa9bf8af3c491b3510f6 (diff) | |
Improve docstrings for sphinx.
Diffstat (limited to 'unittest_utils.py')
| -rw-r--r-- | unittest_utils.py | 11 |
1 files changed, 7 insertions, 4 deletions
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 |
