Skip to content

Commit fd2b0e3

Browse files
committed
Refine doc comments to better call out combined nature of upload progress
1 parent 7b667e6 commit fd2b0e3

File tree

2 files changed

+10
-7
lines changed
  • crates
    • matrix-sdk-ui/src/timeline/event_item
    • matrix-sdk/src/send_queue

2 files changed

+10
-7
lines changed

crates/matrix-sdk-ui/src/timeline/event_item/local.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,14 +91,15 @@ pub enum EventSendState {
9191
/// This type represents the "send progress" of a local event timeline item.
9292
#[derive(Clone, Debug)]
9393
pub enum EventSendProgress {
94-
/// A media is being uploaded.
94+
/// A media (consisting of a file and possibly a thumbnail) is being
95+
/// uploaded.
9596
MediaUpload {
9697
/// The index of the media within the transaction. A file and its
9798
/// thumbnail share the same index.
9899
index: u64,
99100

100-
/// The current combined upload progress for both the file and,
101-
/// if it exists, its thumbnail.
102-
progress: RelativeTransmissionProgress,
101+
/// The combined upload progress across the file and, if existing, its
102+
/// thumbnail.
103+
progress: AbstractProgress,
103104
},
104105
}

crates/matrix-sdk/src/send_queue/mod.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2240,7 +2240,8 @@ pub enum RoomSendQueueUpdate {
22402240
event_id: OwnedEventId,
22412241
},
22422242

2243-
/// A media upload has made progress.
2243+
/// A media upload (consisting of a file and possibly a thumbnail) has made
2244+
/// progress.
22442245
MediaUpload {
22452246
/// The media event this uploaded media relates to.
22462247
related_to: OwnedTransactionId,
@@ -2252,8 +2253,9 @@ pub enum RoomSendQueueUpdate {
22522253
/// thumbnail share the same index.
22532254
index: u64,
22542255

2255-
/// The transmission progress of this individual file.
2256-
progress: RelativeTransmissionProgress,
2256+
/// The combined upload progress across the file and, if existing, its
2257+
/// thumbnail.
2258+
progress: AbstractProgress,
22572259
},
22582260
}
22592261

0 commit comments

Comments
 (0)