add Retry.__call__ docstring

Anvil · Dec 19, 2023 · 2730a41 · 2730a41
1 parent 300f029
commit 2730a41
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/kaioretry/decorator.py b/kaioretry/decorator.py
@@ -120,6 +120,7 @@ class Retry:
     :param logger: the :py:class:`logging.Logger` to which the log
         messages will be sent to.
 
+    .. automethod:: __call__
     """
 
     DEFAULT_LOGGER: Final[logging.Logger] = logging.getLogger(__name__)
@@ -312,6 +313,12 @@ def is_func_async(cls, func: Callable[FuncParam, Any]) \
 
     def __call__(self, func: Callable[FuncParam, FuncRetVal]) \
             -> Callable[FuncParam, FuncRetVal]:
+        """Decorate a function the most accurately possible.
+
+        if ``func`` is a function that involves asyncio, use
+           :py:meth:`~kaioretry.decorator.Retry.aioretry`, else use
+           :py:meth:`~kaioretry.decorator.Retry.retry`.
+        """
         if self.is_func_async(func):
             return cast(Callable[FuncParam, FuncRetVal], self.aioretry(func))
         return self.retry(func)