Skip to content

Commit eeac361

Browse files
authored
Rollup merge of #37978 - fkjogu:master, r=sfackler
Define `bound` argument in std::sync::mpsc::sync_channel in the documentation The `bound` argument in `std::sync::mpsc::sync:channel(bound: usize)` was not defined in the documentation.
2 parents 6ffcdff + a3e03e4 commit eeac361

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/libstd/sync/mpsc/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -491,11 +491,11 @@ pub fn channel<T>() -> (Sender<T>, Receiver<T>) {
491491
/// becomes available. These channels differ greatly in the semantics of the
492492
/// sender from asynchronous channels, however.
493493
///
494-
/// This channel has an internal buffer on which messages will be queued. When
495-
/// the internal buffer becomes full, future sends will *block* waiting for the
496-
/// buffer to open up. Note that a buffer size of 0 is valid, in which case this
497-
/// becomes "rendezvous channel" where each send will not return until a recv
498-
/// is paired with it.
494+
/// This channel has an internal buffer on which messages will be queued. `bound`
495+
/// specifies the buffer size. When the internal buffer becomes full, future sends
496+
/// will *block* waiting for the buffer to open up. Note that a buffer size of 0
497+
/// is valid, in which case this becomes "rendezvous channel" where each send will
498+
/// not return until a recv is paired with it.
499499
///
500500
/// As with asynchronous channels, all senders will panic in `send` if the
501501
/// `Receiver` has been destroyed.

0 commit comments

Comments
 (0)