about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRobert Clipsham <robert@octarineparrot.com>2014-08-26 12:51:36 +0100
committerRobert Clipsham <robert@octarineparrot.com>2014-08-26 15:39:22 +0100
commitc56aa8bfcca4f0fddf9bb1dc231588908ad0b916 (patch)
tree1a437574e9eb6a0bf65c769ea387c8a01eed9e90
parent1cad4089ba0dc46248da2459af904e38243f294d (diff)
downloadrust-c56aa8bfcca4f0fddf9bb1dc231588908ad0b916.tar.gz
rust-c56aa8bfcca4f0fddf9bb1dc231588908ad0b916.zip
Clarify what tx and rx mean
Add a short explanation of what tx and rx mean in terms of channels.
-rw-r--r--src/libsync/comm/mod.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libsync/comm/mod.rs b/src/libsync/comm/mod.rs
index e4df661b562..16bcdd9bbb6 100644
--- a/src/libsync/comm/mod.rs
+++ b/src/libsync/comm/mod.rs
@@ -86,6 +86,8 @@
 //!
 //! ```
 //! // Create a shared channel which can be sent along from many tasks
+//! // where tx is the sending half (tx for transmission), and rx is the receiving
+//! // half (rx for receiving).
 //! let (tx, rx) = channel();
 //! for i in range(0i, 10i) {
 //!     let tx = tx.clone();
@@ -473,6 +475,8 @@ impl<T> UnsafeFlavor<T> for Receiver<T> {
 /// # Example
 ///
 /// ```
+/// // tx is is the sending half (tx for transmission), and rx is the receiving
+/// // half (rx for receiving).
 /// let (tx, rx) = channel();
 ///
 /// // Spawn off an expensive computation