Update src/lib.rs

Co-authored-by: Matěj Laitl <[email protected]>
tonarino · Aug 13, 2024 · df86f8f · df86f8f
1 parent ba3dba1
commit df86f8f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -315,6 +315,9 @@ impl<M> Context<M> {
     ///
     /// Note that subscribing twice to the same event would result in duplicate events -- no
     /// de-duplication of subscriptions is performed.
+    ///
+    /// This method may fail if it is not possible to send the latest event. In this case it is
+    /// guaranteed that the subscription did not take place. You can safely try again.
     pub fn subscribe_and_receive_latest<E: Event + Into<M>>(&self) -> Result<(), SendError>
     where
         M: 'static,