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.

Sign up for GitHub

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

Clarify waiter retries example docs #646

Merged
merged 1 commit into from
Dec 1, 2020
Merged

Clarify waiter retries example docs #646

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions docs/source/1.0/spec/waiters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,10 @@ or equal to ``minDelay``, then set ``delay`` to ``remainingTime`` minus
``minDelay`` and perform one last retry. This prevents a waiter from waiting
needlessly only to exceed ``maxWaitTime`` before issuing a final request.

Using the default ``minDelay`` of 2, ``maxDelay`` of 120, a ``maxWaitTime``
of 300 (5 minutes), and assuming that requests complete in 0 seconds
(for example purposes only), delays are computed as follows:
Using the default ``minDelay`` of 2, the default ``maxDelay`` of 120, a caller
provided ``maxWaitTime`` of 300 (5 minutes), and assuming that requests
complete in 0 seconds (for example purposes only), delays are computed as
follows:

.. list-table::
:header-rows: 1
Expand Down