user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rollup merge of #40977 - projektir:BarrierWaitResult_doc, r=steveklabnik

Browse source 
Updating the description for BarrierWaitResult #29377

Referencing `Barrier`, removing reference to `is_leader`.
This commit is contained in:
Corey Farwell 2017-04-05 12:44:26 -04:00 • committed by GitHub
commit 1a9f415bfb
1 changed files with 4 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/libstd/sync/barrier.rs
View file

@ -50,12 +50,11 @@ struct BarrierState {
generation_id: usize,
}
/// A result returned from wait.
/// A `BarrierWaitResult` is returned by [`wait`] when all threads in the [`Barrier`]
/// have rendezvoused.
///
/// Currently this opaque structure only has one method, [`.is_leader`]. Only
/// one thread will receive a result that will return `true` from this function.
///
/// [`.is_leader`]: #method.is_leader
/// [`wait`]: struct.Barrier.html#method.wait
/// [`Barrier`]: struct.Barrier.html
///
/// # Examples
///