docs: Fix inaccuracies around send

oguzbilgener · Apr 2, 2021 · bfe74a5 · bfe74a5
1 parent d282479
commit bfe74a5
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -61,4 +61,4 @@ async fn main() {
 
 #### Unbounded Channel
 
-There is also an unbounded alternative, `bmrng::unbounded_channel()` with non-blocking `.send()` calls.
+There is also an unbounded alternative, `bmrng::unbounded_channel()` with sync `.send()` calls.
diff --git a/src/bounded.rs b/src/bounded.rs
@@ -57,7 +57,7 @@ impl<Req, Res> RequestSender<Req, Res> {
     ///
     /// Return the [`ResponseReceiver`] which can be used to wait for a response
     ///
-    /// This call blocks if the request channel is full. It does not wait for a response
+    /// This call waits if the request channel is full. It does not wait for a response
     pub async fn send(&self, request: Req) -> Result<ResponseReceiver<Res>, SendError<Req>> {
         let (response_sender, response_receiver) = oneshot::channel::<Res>();
         let responder = Responder::new(response_sender);
@@ -72,7 +72,7 @@ impl<Req, Res> RequestSender<Req, Res> {
 
     /// Send a request over the MPSC channel, wait for the response and return it
     ///
-    /// This call blocks if the request channel is full, and while waiting for the response
+    /// This call waits if the request channel is full, and while waiting for the response
     pub async fn send_receive(&self, request: Req) -> Result<Res, RequestError<Req>> {
         let mut receiver = self.send(request).await?;
         receiver.recv().await.map_err(|err| err.into())

diff --git a/src/unbounded.rs b/src/unbounded.rs
@@ -47,8 +47,6 @@ impl<Req, Res> UnboundedRequestSender<Req, Res> {
 
     /// Send a request over the MPSC channel, open the response channel
     /// Return the [`ResponseReceiver`] which can be used to wait for a response
-    ///
-    /// This call blocks if the request channel is full. It does not wait for a response
     pub fn send(&self, request: Req) -> Result<ResponseReceiver<Res>, SendError<Req>> {
         let (response_sender, response_receiver) = oneshot::channel::<Res>();
         let responder = UnboundedResponder::new(response_sender);
@@ -61,8 +59,6 @@ impl<Req, Res> UnboundedRequestSender<Req, Res> {
     }
 
     /// Send a request over the MPSC channel, wait for the response and return it
-    ///
-    /// This call blocks if the request channel is full, and while waiting for the response
     pub async fn send_receive(&self, request: Req) -> Result<Res, RequestError<Req>> {
         let mut receiver = self.send(request)?;
         receiver.recv().await.map_err(|err| err.into())