Skip to content

Commit 44d8b23

Browse files
committed
Updating the description for BarrierWaitResult #29377
1 parent 5c94997 commit 44d8b23

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

src/libstd/sync/barrier.rs

+4-5
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,11 @@ struct BarrierState {
5050
generation_id: usize,
5151
}
5252

53-
/// A result returned from wait.
53+
/// A `BarrierWaitResult` is returned by [`wait`] when all threads in the [`Barrier`]
54+
/// have rendezvoused.
5455
///
55-
/// Currently this opaque structure only has one method, [`.is_leader`]. Only
56-
/// one thread will receive a result that will return `true` from this function.
57-
///
58-
/// [`.is_leader`]: #method.is_leader
56+
/// [`wait`]: struct.Barrier.html#method.wait
57+
/// [`Barrier`]: struct.Barrier.html
5958
///
6059
/// # Examples
6160
///

0 commit comments

Comments
 (0)