docs: clarify EventuallyWithTf callback vs failure message#1893
Open
leno23 wants to merge 1 commit into
Open
Conversation
The godoc examples implied format strings belong on the condition callback. Document that msg/args apply only on timeout. Fixes stretchr#1833
leno23
force-pushed
the
docs/eventually-withtf-1833
branch
from
4d42955 to
2d7c85c
Compare
dolmen
requested changes
May 17, 2026
Collaborator
dolmen
left a comment
dolmen
left a comment
There was a problem hiding this comment.
Doc changes must be applied in assert/assertions.go, and then run .ci.gogenerate.sh.
| // }, 10*time.Second, 1*time.Second, "externalValue was not true before timeout") | ||
| // | ||
| // The msg and args format the failure when the condition is never met; they are | ||
| // not passed to the condition callback. |
Collaborator
There was a problem hiding this comment.
This change must be applied on assertions.go, and then run go generate github.com/stretchr/testify/... to regenerate dependents.
dolmen
added
documentation
assert.Eventually
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.
Summary
EventuallyWithTfso the condition callback is onlyfunc(c *CollectT)msgandargsformat the timeout failure, not the callbackFixes #1833
Test plan