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

Fix inaccurate documentation of wait_while, wait_while_until & wait_while_for #427

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Jupeyy
Copy link

@Jupeyy Jupeyy commented Feb 21, 2024

The current documentation can be interpreted incorrectly. For example if you wait for a condition that is already false, the current documentation suggests that the current thread will still block.

see rust-lang/rust#121405

@Amanieu
Copy link
Owner

Amanieu commented Mar 12, 2024

I think the new docs are actually harder to read than the old ones. Maybe it might be worth copying the latest docs from the standard library's Condvar if they are clearer: https://doc.rust-lang.org/nightly/std/sync/struct.Condvar.html#method.wait

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants