Skip to content

docs: clarify what time-based stop conditions limit - #769

Open
Luxe7 wants to merge 3 commits into
jd:mainfrom
Luxe7:docs/retry-deadline
Open

Luxe7 wants to merge 3 commits into
jd:mainfrom
Luxe7:docs/retry-deadline

Conversation

@Luxe7

@Luxe7 Luxe7 commented Oct 26, 2026

Copy link
Copy Markdown

The stop_before_delay docs read as if it guarantees a timeout for the whole call. It checks the elapsed time plus the next wait, but it cannot interrupt a running attempt.

This clarifies the distinction in the guide and API docs, and adds a fixed-wait example showing where retries stop. Runtime behavior is unchanged.

Checked on Python 3.14: 185 tests, Ruff, mypy, and the Sphinx doctest and HTML builds passed. A simulated clock also confirmed the four-attempt example and that a successful call can finish after the limit.

Luxe7 added 3 commits October 26, 2026 13:53
Explain that stop conditions do not interrupt running attempts.
Describe the elapsed-time and upcoming-wait check.
Record the documentation correction.
@mergify

mergify Bot commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant