Skip to content

Documentation mismatch for WaitTimeoutResult::timed_out #110045

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.

Sign up for GitHub

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

Jump to bottom
Closed
wyf18 opened this issue Apr 7, 2023 · 0 comments · Fixed by #110056
Closed

Documentation mismatch for WaitTimeoutResult::timed_out #110045

wyf18 opened this issue Apr 7, 2023 · 0 comments · Fixed by #110056
Assignees
@chenyukang
Labels
A-atomic Area: Atomics, barriers, and sync primitives A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs Relevant to the library team, which will review and decide on the PR/issue.

Comments

@wyf18
Copy link

wyf18 commented Apr 7, 2023

Location

Standard library documentation for WaitTimeoutResult::timed_out
(https://doc.rust-lang.org/std/sync/struct.WaitTimeoutResult.html#method.timed_out)

Summary

The example of the document does not mention the timed_out method, it is not clear how to use it.
@wyf18 wyf18 added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Apr 7, 2023
@jyn514 jyn514 added T-libs Relevant to the library team, which will review and decide on the PR/issue. A-atomic Area: Atomics, barriers, and sync primitives labels Apr 7, 2023
@chenyukang chenyukang self-assigned this Apr 7, 2023
@chenyukang chenyukang mentioned this issue Apr 7, 2023
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jul 30, 2023
@matthiaskrgr
Rollup merge of rust-lang#110056 - chenyukang:yukang/fix-110045, r=wo…
7492cf9 
…rkingjubilee

Fix the example in document for WaitTimeoutResult::timed_out

Fixes rust-lang#110045
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jul 30, 2023
@matthiaskrgr
Rollup merge of rust-lang#110056 - chenyukang:yukang/fix-110045, r=wo…
cb6e8d1 
…rkingjubilee

Fix the example in document for WaitTimeoutResult::timed_out

Fixes rust-lang#110045
@bors bors closed this as completed in e517ee0 Jul 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chenyukang chenyukang

Labels
A-atomic Area: Atomics, barriers, and sync primitives A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix the example in document for WaitTimeoutResult::timed_out chenyukang/rust
3 participants
@chenyukang @jyn514 @wyf18