From be7462e50fe21c3eea578e12765f501e1157072b Mon Sep 17 00:00:00 2001
From: Zephyr Shannon <geoffpshannon@gmail.com>
Date: Wed, 9 Sep 2020 13:28:28 -0700
Subject: sync: document mpsc::bounded minimum buffer size (#2808)

---
 tokio/src/sync/mpsc/unbounded.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'tokio/src/sync/mpsc/unbounded.rs')

diff --git a/tokio/src/sync/mpsc/unbounded.rs b/tokio/src/sync/mpsc/unbounded.rs
index 1b2288ab..6b2ca722 100644
--- a/tokio/src/sync/mpsc/unbounded.rs
+++ b/tokio/src/sync/mpsc/unbounded.rs
@@ -47,7 +47,7 @@ impl<T> fmt::Debug for UnboundedReceiver<T> {
 }
 
 /// Creates an unbounded mpsc channel for communicating between asynchronous
-/// tasks.
+/// tasks without backpressure.
 ///
 /// A `send` on this channel will always succeed as long as the receive half has
 /// not been closed. If the receiver falls behind, messages will be arbitrarily
-- 
cgit v1.2.3