From 5be3ea3d46428c3f4890ee36059ebb63da28f885 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 6 Jan 2026 12:26:41 +0000 Subject: [PATCH] common: Fix up documentation on `TimelineEvent` https://github.com/matrix-org/matrix-rust-sdk/pull/4568 merged together `SyncTimelineEvent` and `TimelineEvent`, but removed some of the useful documentation on `TimelineEvent`, and left behind some confusing references. This change fixes it up. --- .../matrix-sdk-common/src/deserialized_responses.rs | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/crates/matrix-sdk-common/src/deserialized_responses.rs b/crates/matrix-sdk-common/src/deserialized_responses.rs index 4151eb010..ff197a691 100644 --- a/crates/matrix-sdk-common/src/deserialized_responses.rs +++ b/crates/matrix-sdk-common/src/deserialized_responses.rs @@ -465,12 +465,13 @@ impl ThreadSummaryStatus { } } -/// Represents a Matrix room event that has been returned from `/sync`, -/// after initial processing. +/// Represents a matrix room event that has been returned from a Matrix +/// client-server API endpoint such as `/sync` or `/messages`, after initial +/// processing. /// -/// Previously, this differed from [`TimelineEvent`] by wrapping an -/// [`AnySyncTimelineEvent`] instead of an [`AnyTimelineEvent`], but nowadays -/// they are essentially identical, and one of them should probably be removed. +/// The "initial processing" includes an attempt to decrypt encrypted events, so +/// the main thing this adds over [`AnyTimelineEvent`] is information on +/// encryption. // // 🚨 Note about this type, please read! 🚨 //