adjust documentation

smol-rs · Jan 16, 2024 · 57a0ea7 · 57a0ea7
1 parent 396492d
commit 57a0ea7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -481,7 +481,8 @@ impl<T> Event<T> {
     }
 
     /// Return the listener count
-    ///
+    /// This is just a snapshot of the number of listeners at this point in time. It is possible for the actual number to change at any point.
+    /// The number should only ever be used as a hint.
     /// This is only available when `std` feature is enabled.
     ///
     /// # Examples

diff --git a/src/std.rs b/src/std.rs
@@ -56,8 +56,6 @@ impl<T> List<T> {
     }
 
     // Get the listener count by blocking
-    // This is just a snapshot of the number of listeners at this point in time. It is possible for the actual number to change at any point.
-    // The number should only ever be used as a hint.
     pub(crate) fn total_listeners_wait(&self) -> usize {
         match self.0.lock() {
             Ok(mutex) => mutex.len,