Parcourir la source

net: expand the descriptive comment in subscribe_stop signature

ghassmo il y a 4 ans
Parent
commit
64e32310f8
1 fichiers modifiés avec 1 ajouts et 0 suppressions
  1. 1 0
      src/net/channel.rs

+ 1 - 0
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={}]",