docs(interfaces): clarify that attempts is 1-indexed during a run - #620
Merged
Conversation
`attempts` is incremented when a job is locked for execution, so a
running handler sees `attempts === 1` on the first run and
`attempts === max_attempts` on the final run. The previous wording
("How many times it has been attempted") is easy to misread as "prior
failures", which leads to off-by-one final-attempt checks. Spell out
the semantics on `attempts` and refine the related `last_error`
comment, which read as inaccurate for the first in-flight attempt.
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
2 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.
attemptsis incremented when a job is locked for execution, so a running handler seesattempts === 1on the first run andattempts === max_attemptson the final run. The previous wording ("How many times it has been attempted") is easy to misread as "prior failures", which leads to off-by-one final-attempt checks. Spell out the semantics onattemptsand refine the relatedlast_errorcomment, which read as inaccurate for the first in-flight attempt.Description
Performance impact
Security impact
Checklist
yarn lint:fixpasses.yarn testpasses.RELEASE_NOTES.mdfile (if one exists).