Skip to content

Commit

Permalink
doc(sdk): Simplify documentation of RoomEventCache::subscribe.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Hywan authored and poljar committed Jan 17, 2025
1 parent f7db52e commit 453c4e1
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions crates/matrix-sdk/src/event_cache/room/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<SyncTimelineEvent>, Receiver<RoomEventCacheUpdate>)> {
Expand Down

0 comments on commit 453c4e1

Please sign in to comment.