Bladeren bron

net/channel: correct and reword docstring comment

x 2 jaren geleden
bovenliggende
commit
be70993c22
1 gewijzigde bestanden met toevoegingen van 2 en 3 verwijderingen
  1. 2 3
      src/net/channel.rs

+ 2 - 3
src/net/channel.rs

@@ -137,9 +137,8 @@ impl Channel {
         debug!(target: "net::channel::start()", "END {:?}", self);
         debug!(target: "net::channel::start()", "END {:?}", self);
     }
     }
 
 
-    /// Stops the channel. Steps through each component of the channel connection
-    /// and sends a stop signal. Notifies all subscribers that the channel has
-    /// been closed.
+    /// Stops the channel.
+    /// Notifies all subscribers that the channel has been closed in `handle_stop()`.
     pub async fn stop(&self) {
     pub async fn stop(&self) {
         debug!(target: "net::channel::stop()", "START {:?}", self);
         debug!(target: "net::channel::stop()", "START {:?}", self);
         self.receive_task.stop().await;
         self.receive_task.stop().await;