Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: unify the name before sleep strategy in docstring and comments #491

Merged
merged 1 commit into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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