Skip to content

Commit

Permalink
fix confusing eventually docs
Browse files Browse the repository at this point in the history
  • Loading branch information
onsi committed Apr 25, 2024
1 parent f2e65fc commit 3a66379
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions gomega_dsl.go
Original file line number Diff line number Diff line change
Expand Up @@ -372,11 +372,11 @@ You can ensure that you get a number of consecutive successful tries before succ
Finally, in addition to passing timeouts and a context to Eventually you can be more explicit with Eventually's chaining configuration methods:
Eventually(..., "1s", "2s", ctx).Should(...)
Eventually(..., "10s", "2s", ctx).Should(...)
is equivalent to
Eventually(...).WithTimeout(time.Second).WithPolling(2*time.Second).WithContext(ctx).Should(...)
Eventually(...).WithTimeout(10*time.Second).WithPolling(2*time.Second).WithContext(ctx).Should(...)
*/
func Eventually(actualOrCtx interface{}, args ...interface{}) AsyncAssertion {
ensureDefaultGomegaIsConfigured()
Expand Down

0 comments on commit 3a66379

Please sign in to comment.