Skip to content

Commit 89183a3

Browse files
committed
doc(timeline): rejigger a doc comment around sending attachments
1 parent 65ed4f3 commit 89183a3

File tree

1 file changed

+6
-7
lines changed
  • crates/matrix-sdk-ui/src/timeline

1 file changed

+6
-7
lines changed

crates/matrix-sdk-ui/src/timeline/mod.rs

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -529,22 +529,21 @@ impl Timeline {
529529
Ok(())
530530
}
531531

532-
/// Sends an attachment to the room. It does not currently support local
533-
/// echoes
532+
/// Sends an attachment to the room.
533+
///
534+
/// It does not currently support local echoes.
534535
///
535536
/// If the encryption feature is enabled, this method will transparently
536537
/// encrypt the room message if the room is encrypted.
537538
///
538539
/// # Arguments
539540
///
540-
/// * `path` - The path of the file to be sent
541+
/// * `path` - The path of the file to be sent.
541542
///
542-
/// * `mime_type` - The attachment's mime type
543+
/// * `mime_type` - The attachment's mime type.
543544
///
544545
/// * `config` - An attachment configuration object containing details about
545-
/// the attachment
546-
///
547-
/// like a thumbnail, its size, duration etc.
546+
/// the attachment like a thumbnail, its size, duration etc.
548547
#[instrument(skip_all)]
549548
pub fn send_attachment(
550549
&self,

0 commit comments

Comments
 (0)