about summary refs log tree commit diff
path: root/src/libstd/sync
diff options
context:
space:
mode:
authorSeo Sanghyeon <sanxiyn@gmail.com>2016-11-26 22:02:14 +0900
committerGitHub <noreply@github.com>2016-11-26 22:02:14 +0900
commiteeac361f52a06d37ad3f9120866f895db957c745 (patch)
tree27cb4d77ec05c69c0fd8eb9ebf23caf533067373 /src/libstd/sync
parent6ffcdff06c11c372156571dc50096b001d7f97ef (diff)
parenta3e03e42e1298b49b647c8f80050421458414385 (diff)
downloadrust-eeac361f52a06d37ad3f9120866f895db957c745.tar.gz
rust-eeac361f52a06d37ad3f9120866f895db957c745.zip
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.
Diffstat (limited to 'src/libstd/sync')
-rw-r--r--src/libstd/sync/mpsc/mod.rs10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/libstd/sync/mpsc/mod.rs b/src/libstd/sync/mpsc/mod.rs
index 2773629c7d7..ca6e46eb15a 100644
--- a/src/libstd/sync/mpsc/mod.rs
+++ b/src/libstd/sync/mpsc/mod.rs
@@ -491,11 +491,11 @@ pub fn channel<T>() -> (Sender<T>, Receiver<T>) {
 /// becomes available. These channels differ greatly in the semantics of the
 /// sender from asynchronous channels, however.
 ///
-/// This channel has an internal buffer on which messages will be queued. When
-/// the internal buffer becomes full, future sends will *block* waiting for the
-/// buffer to open up. Note that a buffer size of 0 is valid, in which case this
-/// becomes  "rendezvous channel" where each send will not return until a recv
-/// is paired with it.
+/// This channel has an internal buffer on which messages will be queued. `bound`
+/// specifies the buffer size. When the internal buffer becomes full, future sends
+/// will *block* waiting for the buffer to open up. Note that a buffer size of 0
+/// is valid, in which case this becomes  "rendezvous channel" where each send will
+/// not return until a recv is paired with it.
 ///
 /// As with asynchronous channels, all senders will panic in `send` if the
 /// `Receiver` has been destroyed.