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.

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

Correct the EventuallyWithT and EventuallyWithTf example #1588

Merged
merged 1 commit into from
Apr 17, 2024

Conversation

JonCrowther
Copy link
Contributor

@JonCrowther JonCrowther commented Apr 12, 2024

Summary

The example used for EventuallyWithT documentation doesn't actually pass.

Changes

Updated the example to be correct by swapping the times used for waitFor and tick

Motivation

I was looking at the docs and, based on the example, mistakenly set waitFor to be a shorter time than tick, which means condition never gets called. Hopefully this helps other people avoid the same mistake.

Copy link
Collaborator

@dolmen dolmen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dolmen dolmen merged commit a61e9e5 into stretchr:master Apr 17, 2024
7 checks passed
@dolmen dolmen added documentation assert.Eventually About assert.Eventually/EventuallyWithT pkg-assert Change related to package testify/assert labels Apr 17, 2024
@JonCrowther JonCrowther deleted the fix-eventuallywithtf-example branch April 17, 2024 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
assert.Eventually About assert.Eventually/EventuallyWithT documentation pkg-assert Change related to package testify/assert
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants