docs: clarify WorkflowStepConfig retry limit semantics#30724
Open
qianzhu18 wants to merge 1 commit into
Open
Conversation
Contributor
|
Hey there, we've marked this pull request as stale because there's no recent activity on it. This label helps us identify PRs that might need updates (or to be closed out by our team if no longer relevant). |
elithrar
approved these changes
Jun 12, 2026
elithrar
left a comment
Collaborator
There was a problem hiding this comment.
Approved as a low-risk product-owner docs change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
retries.limitis the number of retries, not total attemptslimit: 10means 11 total attemptsWhy
Issue #30627 points out that the prose says the sample limits a step to 10 retries, while the inline code comment says
limitis the total number of attempts. This update makes the example internally consistent with the documented behavior.Closes #30627