doc(base): Improve documentation.

matrix-org · Jun 17, 2024 · cb029ce · cb029ce
1 parent 1fc2f31
commit cb029ce
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/crates/matrix-sdk-base/src/store/mod.rs b/crates/matrix-sdk-base/src/store/mod.rs
@@ -227,7 +227,8 @@ impl Store {
             .collect()
     }
 
-    /// Get a stream of all the rooms, in addition to the existing rooms.
+    /// Get a stream of all the rooms changes, in addition to the existing
+    /// rooms.
     #[cfg(not(target_arch = "wasm32"))]
     pub fn rooms_stream(&self) -> (Vector<Room>, impl Stream<Item = Vec<VectorDiff<Room>>>) {
         self.rooms.read().unwrap().stream()

diff --git a/crates/matrix-sdk-base/src/store/observable_map.rs b/crates/matrix-sdk-base/src/store/observable_map.rs
@@ -126,7 +126,7 @@ mod impl_non_wasm32 {
             self.values.iter()
         }
 
-        /// Get a [`Stream`] of it.
+        /// Get a [`Stream`] of the values.
         pub(crate) fn stream(&self) -> (Vector<V>, impl Stream<Item = Vec<VectorDiff<V>>>) {
             self.values.subscribe().into_values_and_batched_stream()
         }