Skip to content

docs(workflow): clarify RetryPolicy field docstrings #1204

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

Open
magic-peach wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(workflow): clarify RetryPolicy field docstrings #1204

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
13 changes: 9 additions & 4 deletions dapr/ext/workflow/retry_policy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,18 @@ def __init__(

Args:
first_retry_interval(timedelta): The retry interval to use for the first retry attempt.
max_number_of_attempts(int): The maximum number of retry attempts.
max_number_of_attempts(int): The total number of attempts, including the first one,
not the number of retries after the first attempt.
backoff_coefficient(Optional[float]): The backoff coefficient to use for calculating
the next retry interval.
the next retry interval. With the default of 1.0, every retry interval is
first_retry_interval; a coefficient above 1.0 grows the interval on each attempt
up to max_retry_interval, if set.
max_retry_interval(Optional[timedelta]): The maximum retry interval to use for any
retry attempt.
retry attempt. Leaving this unset means the interval keeps growing without a cap
when backoff_coefficient is above 1.0.
retry_timeout(Optional[timedelta]): The maximum amount of time to spend retrying the
operation.
operation. Once exceeded, the activity or workflow fails outright, even if
max_number_of_attempts has not been reached, so its own final attempt is not run.
"""
# validate inputs
if first_retry_interval < timedelta(seconds=0):
Expand Down