From d65bf3805be376505f5c2fb0724cec8917dfb813 Mon Sep 17 00:00:00 2001
From: Vojtech Kral <vojtech@kral.hk>
Date: Sat, 4 Apr 2020 19:36:12 +0200
Subject: [PATCH] doc: add error explanation for UnboundedSender::send()
 (#2372)

---
 tokio/src/sync/mpsc/bounded.rs   | 4 ++--
 tokio/src/sync/mpsc/unbounded.rs | 7 +++++++
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/tokio/src/sync/mpsc/bounded.rs b/tokio/src/sync/mpsc/bounded.rs
index f83c05322..a0b6db386 100644
--- a/tokio/src/sync/mpsc/bounded.rs
+++ b/tokio/src/sync/mpsc/bounded.rs
@@ -360,8 +360,8 @@ impl<T> Sender<T> {
     /// # Errors
     ///
     /// If the receive half of the channel is closed, either due to [`close`]
-    /// being called or the [`Receiver`] handle dropping, the function returns
-    /// an error. The error includes the value passed to `send`.
+    /// being called or the [`Receiver`] having been dropped,
+    /// the function returns an error. The error includes the value passed to `send`.
     ///
     /// [`close`]: Receiver::close
     /// [`Receiver`]: Receiver
diff --git a/tokio/src/sync/mpsc/unbounded.rs b/tokio/src/sync/mpsc/unbounded.rs
index b6b621d25..ba543fe4c 100644
--- a/tokio/src/sync/mpsc/unbounded.rs
+++ b/tokio/src/sync/mpsc/unbounded.rs
@@ -162,6 +162,13 @@ impl<T> UnboundedSender<T> {
     }
 
     /// Attempts to send a message on this `UnboundedSender` without blocking.
+    ///
+    /// If the receive half of the channel is closed, either due to [`close`]
+    /// being called or the [`UnboundedReceiver`] having been dropped,
+    /// the function returns an error. The error includes the value passed to `send`.
+    ///
+    /// [`close`]: UnboundedReceiver::close
+    /// [`UnboundedReceiver`]: UnboundedReceiver
     pub fn send(&self, message: T) -> Result<(), SendError<T>> {
         self.chan.send_unbounded(message)?;
         Ok(())