From 64e32310f8b97d8520cd1150caa42d56d2c09047 Mon Sep 17 00:00:00 2001
From: ghassmo <ghxxm@protonmail.com>
Date: Fri, 10 Jun 2022 16:20:04 +0300
Subject: [PATCH] net: expand the descriptive comment in subscribe_stop
 signature

---
 src/net/channel.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/net/channel.rs b/src/net/channel.rs
index 46a9d2d56..02ae2125d 100644
--- a/src/net/channel.rs
+++ b/src/net/channel.rs
@@ -127,6 +127,7 @@ impl Channel {
     }
 
     /// Creates a subscription to a stopped signal.
+    /// If the channel is stopped then this will return a ChannelStopped error.
     pub async fn subscribe_stop(&self) -> Result<Subscription<Error>> {
         debug!(target: "net",
          "Channel::subscribe_stop() [START, address={}]",