From 453c4e12dbec4f710c14f840fffc03c17198e1c4 Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Fri, 17 Jan 2025 13:38:31 +0100 Subject: [PATCH] doc(sdk): Simplify documentation of `RoomEventCache::subscribe`. This patch removes a `XXX` (which I believe is a TODO) in the documentation of `RoomEventCache::subscribe`. We are not going to change this API anytime soon. --- crates/matrix-sdk/src/event_cache/room/mod.rs | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/crates/matrix-sdk/src/event_cache/room/mod.rs b/crates/matrix-sdk/src/event_cache/room/mod.rs index 5d011d4a906..0d76dc63ec2 100644 --- a/crates/matrix-sdk/src/event_cache/room/mod.rs +++ b/crates/matrix-sdk/src/event_cache/room/mod.rs @@ -75,10 +75,8 @@ impl RoomEventCache { } } - /// Subscribe to room updates for this room, after getting the initial list - /// of events. XXX: Could/should it use some kind of `Observable` - /// instead? Or not something async, like explicit handlers as our event - /// handlers? + /// Subscribe to this room updates, after getting the initial list of + /// events. pub async fn subscribe( &self, ) -> Result<(Vec, Receiver)> {