Update docs

tokio-rs · Sep 19, 2023 · bc3b49d · bc3b49d
1 parent e14644c
commit bc3b49d
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/tokio/src/sync/watch.rs b/tokio/src/sync/watch.rs
@@ -645,6 +645,13 @@ impl<T> Receiver<T> {
     }
 
     /// Marks the state as changed.
+    ///
+    /// After invoking this method [`has_changed()`](Self::has_changed)
+    /// returns `true` and [`changed()`](Self::changed) returns
+    /// immediately, regardless of whether a new value has been sent.
+    ///
+    /// This is useful for triggering an initial change notification after
+    /// subscribing to synchronize new receivers.
     pub fn mark_changed(&mut self) {
         self.version.decrement();
     }