Rollup merge of rust-lang#40977 - projektir:BarrierWaitResult_doc, r=…

…steveklabnik Updating the description for BarrierWaitResult rust-lang#29377 Referencing `Barrier`, removing reference to `is_leader`.
frewsxcv · Apr 3, 2017 · 7c3f92b · 7c3f92b
2 parents 391b8b6 + 44d8b23
commit 7c3f92b
Showing 1 changed file with 4 additions and 5 deletions.
diff --git 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
 ///