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.
2026-01-06 12:26:41 +00:00
parent 7b16a32910
commit 5be3ea3d46
1 changed files with 6 additions and 5 deletions
@@ -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! 🚨
 //