From 1e858172519e9339e4720b8bf9b39b6d9801e305 Mon Sep 17 00:00:00 2001
From: Scott Gasch <scott@gasch.org>
Date: Sat, 28 May 2022 19:29:08 -0700
Subject: Tweak around docstring to make prettier sphinx autodocs.

---
 parallelize.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'parallelize.py')

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
-- 
cgit v1.3