diff options
| author | Corey Farwell <coreyf@rwell.org> | 2017-04-05 12:44:26 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-05 12:44:26 -0400 |
| commit | 1a9f415bfbf95697ddbd4d34f60e384303c0cc16 (patch) | |
| tree | aad21493285754382a6e59090fc75ca0757f5592 /src/libstd | |
| parent | 7412f701e8574c5006e4d5b7c5564a69854bf802 (diff) | |
| parent | 44d8b236f4da3b17bc4a7ac3d571d67acd3be020 (diff) | |
| download | rust-1a9f415bfbf95697ddbd4d34f60e384303c0cc16.tar.gz rust-1a9f415bfbf95697ddbd4d34f60e384303c0cc16.zip | |
Rollup merge of #40977 - projektir:BarrierWaitResult_doc, r=steveklabnik
Updating the description for BarrierWaitResult #29377 Referencing `Barrier`, removing reference to `is_leader`.
Diffstat (limited to 'src/libstd')
| -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 /// |