net/channel: correct and reword docstring comment

This commit is contained in:
x
2023-09-04 13:33:22 +02:00
parent fa43710994
commit be70993c22

View File

@@ -137,9 +137,8 @@ impl Channel {
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) {
debug!(target: "net::channel::stop()", "START {:?}", self);
self.receive_task.stop().await;