diff options
| author | projektir <oprojektir@gmail.com> | 2017-03-31 18:58:32 -0400 |
|---|---|---|
| committer | projektir <oprojektir@gmail.com> | 2017-03-31 18:58:32 -0400 |
| commit | 44d8b236f4da3b17bc4a7ac3d571d67acd3be020 (patch) | |
| tree | 57d32813ad162574be278b079c29ba865c92e932 | |
| parent | 5c94997b6b1cca3e65ecfc5ba40c033d6838019b (diff) | |
| download | rust-44d8b236f4da3b17bc4a7ac3d571d67acd3be020.tar.gz rust-44d8b236f4da3b17bc4a7ac3d571d67acd3be020.zip | |
Updating the description for BarrierWaitResult #29377
| -rw-r--r-- | src/libstd/sync/barrier.rs | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/libstd/sync/barrier.rs b/src/libstd/sync/barrier.rs index 295a49d6a8e..a7b01e49d2b 100644 --- a/src/libstd/sync/barrier.rs +++ b/src/libstd/sync/barrier.rs @@ -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 /// |