doc(sdk): Update documentation of SlidingSyncList::state_stream.

aringenbach · Jun 15, 2023 · d935f52 · d935f52
1 parent 0ff9073
commit d935f52
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/matrix-sdk/src/sliding_sync/list/mod.rs b/crates/matrix-sdk/src/sliding_sync/list/mod.rs
@@ -110,6 +110,9 @@ impl SlidingSyncList {
     ///
     /// There's no guarantee of ordering between items emitted by this stream
     /// and those emitted by other streams exposed on this structure.
+    ///
+    /// The first part of the returned tuple is the actual loading state, and
+    /// the second part is the `Stream` to receive updates.
     pub fn state_stream(
         &self,
     ) -> (SlidingSyncListLoadingState, impl Stream<Item = SlidingSyncListLoadingState>) {