doc(sdk): Fix documentation of with_events_mut.

This commit is contained in:
Ivan Enderlin
2025-03-03 07:37:15 +01:00
parent 7694b016da
commit 2036c3da9d

View File

@@ -1244,9 +1244,8 @@ mod private {
/// Gives a temporary mutable handle to the underlying in-memory events,
/// and will propagate changes to the storage once done.
///
/// Returns the output of the given callback, as well as updates to the
/// linked chunk, as vector diff, so the caller may propagate
/// such updates, if needs be.
/// Returns the updates to the linked chunk, as vector diffs, so the
/// caller may propagate such updates, if needs be.
#[must_use = "Updates as `VectorDiff` must probably be propagated via `RoomEventCacheUpdate`"]
pub async fn with_events_mut<F: FnOnce(&mut RoomEvents)>(
&mut self,