From f255e007cad7a368201ae3bea1bfe705fd4feb7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damien=20Nad=C3=A9?= Date: Thu, 23 Nov 2023 11:32:01 +0100 Subject: [PATCH] fix aioretry docstring format --- CHANGELOG.md | 3 ++- kaioretry/__init__.py | 11 ++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d1dc833..590a3ee 100644 --- 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 index cff602f..f300e15 100644 --- 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