From 98c331466e211c871fde1a9ca3be7722ea968373 Mon Sep 17 00:00:00 2001
From: Benjamin Bouvier <benjamin@bouvier.cc>
Date: Tue, 1 Jul 2025 11:06:17 +0200
Subject: [PATCH] doc(timeline): beef up comments for the long-lived tasks

---
 crates/matrix-sdk-ui/src/timeline/tasks.rs | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/crates/matrix-sdk-ui/src/timeline/tasks.rs b/crates/matrix-sdk-ui/src/timeline/tasks.rs
index 8c5320424..6c585c37f 100644
--- a/crates/matrix-sdk-ui/src/timeline/tasks.rs
+++ b/crates/matrix-sdk-ui/src/timeline/tasks.rs
@@ -29,7 +29,8 @@ use tracing::{instrument, trace, warn};
 
 use crate::timeline::{event_item::RemoteEventOrigin, TimelineController, TimelineFocus};
 
-/// The task that handles the pinned event IDs updates.
+/// Long-lived task, in the pinned events focus mode, that updates the timeline
+/// after any changes in the pinned events.
 #[instrument(
     skip_all,
     fields(
@@ -70,7 +71,8 @@ pub(in crate::timeline) async fn pinned_events_task<S>(
     }
 }
 
-/// The task that handles the [`RoomEventCacheUpdate`]s.
+/// Long-lived task that forwards the [`RoomEventCacheUpdate`]s (remote echoes)
+/// to the timeline.
 pub(in crate::timeline) async fn room_event_cache_updates_task(
     room_event_cache: RoomEventCache,
     timeline_controller: TimelineController,
@@ -157,7 +159,8 @@ pub(in crate::timeline) async fn room_event_cache_updates_task(
     }
 }
 
-/// The task that handles the [`RoomSendQueueUpdate`]s.
+/// Long-lived task that forwards [`RoomSendQueueUpdate`]s (local echoes) to the
+/// timeline.
 pub(in crate::timeline) async fn room_send_queue_update_task(
     mut send_queue_stream: Receiver<RoomSendQueueUpdate>,
     timeline_controller: TimelineController,