fix aioretry docstring format

Anvil · Nov 25, 2023 · f255e00 · f255e00
1 parent d11de3b
commit f255e00
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,8 @@
 ### Add
 - Add python 3.12 support
 
-### Fixed
+### Fixes
+* minor issue in aioretry docstring format
 - Fix Context and _ContextIterator type thing
 
 ## [0.10.2] - 2023-05-29

diff --git a/kaioretry/__init__.py b/kaioretry/__init__.py
@@ -128,11 +128,12 @@ def retry(retry_obj: Retry) -> Callable[[Callable[FuncParam, FuncRetVal]],
 
 @_make_decorator
 def aioretry(retry_obj: Retry) -> AioretryProtocol:
-    """Similar to :py:func:`~kaioretry.retry`, this function will produce a
-    new async retry decorator that will produce exact the same results as said
-    :py:func:`~kaioretry.retry`, *except* that the produced decorated
-    functions will be :py:class:`~collections.abc.Coroutine`s, and that delays
-    induced by the `delay` constructor parameter and its friends, will be
+    """Similar to :py:func:`~kaioretry.retry`, this function will produce
+    a new async retry decorator that will produce exact the same
+    results as said :py:func:`~kaioretry.retry`, *except* that the
+    produced decorated functions will be typed as a
+    :py:class:`~collections.abc.Coroutine`, and that delays induced by
+    the `delay` constructor parameter and its friends, will be
     implemented with :py:mod:`asyncio` functions.
 
     That means the decorated version of given functions will be eligible to