diff options
| author | Scott Gasch <[email protected]> | 2022-05-28 19:29:08 -0700 |
|---|---|---|
| committer | Scott Gasch <[email protected]> | 2022-05-28 19:29:08 -0700 |
| commit | 1e858172519e9339e4720b8bf9b39b6d9801e305 (patch) | |
| tree | 75306d5a4eb3a9b512646f0acc5c6174644348a6 /parallelize.py | |
| parent | 52ff365609d3f5a81cb79dc4464b19bd5860cfc0 (diff) | |
Tweak around docstring to make prettier sphinx autodocs.
Diffstat (limited to 'parallelize.py')
| -rw-r--r-- | parallelize.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/parallelize.py b/parallelize.py index 77d7649..6005d42 100644 --- a/parallelize.py +++ b/parallelize.py @@ -22,7 +22,7 @@ class Method(Enum): def parallelize( _funct: typing.Optional[typing.Callable] = None, *, method: Method = Method.THREAD ) -> typing.Callable: - """Usage: + """Usage:: @parallelize # defaults to thread-mode def my_function(a, b, c) -> int: @@ -36,7 +36,7 @@ def parallelize( def my_other_other_function(g, h) -> int: ...this work will be distributed to a remote machine pool - This decorator will invoke the wrapped function on: + This decorator will invoke the wrapped function on:: Method.THREAD (default): a background thread Method.PROCESS: a background process |