Skip to content

Commit

Permalink
docs: unify the name before sleep strategy in docstring and comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Young-Lord authored Aug 23, 2024
1 parent e2482a6 commit b8b1026
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion tenacity/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
from .after import after_log # noqa
from .after import after_nothing # noqa

# Import all built-in after strategies for easier usage.
# Import all built-in before sleep strategies for easier usage.
from .before_sleep import before_sleep_log # noqa
from .before_sleep import before_sleep_nothing # noqa

Expand Down
4 changes: 2 additions & 2 deletions tenacity/before_sleep.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@


def before_sleep_nothing(retry_state: "RetryCallState") -> None:
"""Before call strategy that does nothing."""
"""Before sleep strategy that does nothing."""


def before_sleep_log(
logger: "logging.Logger",
log_level: int,
exc_info: bool = False,
) -> typing.Callable[["RetryCallState"], None]:
"""Before call strategy that logs to some logger the attempt."""
"""Before sleep strategy that logs to some logger the attempt."""

def log_it(retry_state: "RetryCallState") -> None:
local_exc_info: BaseException | bool | None
Expand Down

0 comments on commit b8b1026

Please sign in to comment.