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

Eventually functions documentation is misleading as waitFor and tick are swapped in the example #1677

Closed
delca85 opened this issue Nov 11, 2024 · 3 comments
Assignees
Labels
bug good first issue pkg-assert Change related to package testify/assert

Comments

@delca85
Copy link

delca85 commented Nov 11, 2024

Description

Documentation of EventuallyWithT and EventuallyWithTf functions (in both require or assert package) is misleading, as the sample code swaps waitFor and tick args in the call.

Step To Reproduce

Go to assert.EventuallyWithT docs and look at the example, it shows 1*time.Second, that is supposed to be the tick as 1st argument that should be waitFor.
Same thing for assert.EventuallyWithTf, require.EventuallyWithT and require.EventuallyWithTf.

@delca85 delca85 added the bug label Nov 11, 2024
@brackendawson brackendawson added pkg-assert Change related to package testify/assert good first issue labels Nov 11, 2024
@ChinoUkaegbu
Copy link

Hi, I'd like to work on this! What file(s) should be edited? This search query shows five files but I'm unsure if they all should be edited especially since some of them have a comment at the top to not edit --> // Code generated with github.com/stretchr/testify/_codegen; DO NOT EDIT.

@brackendawson
Copy link
Collaborator

Only edit files without the DO NOT EDIT header. To change the rest you run go generate ./....

@brackendawson
Copy link
Collaborator

Thanks for your efforts, however I now see this was actually fixed in #1588 but that hasn't been released yet.

I do plan to make a v1.10.0 release soon. I have an ordered list of testify tasks for me to do and making the release is currently second on that list.

@brackendawson brackendawson closed this as not planned Won't fix, can't repro, duplicate, stale Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug good first issue pkg-assert Change related to package testify/assert
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants