From c56aa8bfcca4f0fddf9bb1dc231588908ad0b916 Mon Sep 17 00:00:00 2001
From: Robert Clipsham <robert@octarineparrot.com>
Date: Tue, 26 Aug 2014 12:51:36 +0100
Subject: [PATCH] Clarify what tx and rx mean

Add a short explanation of what tx and rx mean in terms of channels.
---
 src/libsync/comm/mod.rs | 4 ++++
 1 file changed, 4 insertions(+)

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