From 12444d3dc12e96c756e90dea6791b0d48314f6b9 Mon Sep 17 00:00:00 2001 From: Denis Kasak Date: Mon, 12 Feb 2024 16:52:00 +0100 Subject: [PATCH] docs: Clarify some doc comments. --- crates/matrix-sdk/src/account.rs | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/crates/matrix-sdk/src/account.rs b/crates/matrix-sdk/src/account.rs index eae71a96d..e2d5ea45f 100644 --- a/crates/matrix-sdk/src/account.rs +++ b/crates/matrix-sdk/src/account.rs @@ -799,16 +799,14 @@ impl Account { Ok(self.client.send(request, None).await?) } - /// Marks the given room with `room_id` as "direct chat" with with any + /// Marks the room identified by `room_id` as a "direct chat" with each /// user in `user_ids`. /// - /// This is done adding new the `room_id` to the list of DM - /// chats for any user id in `user_ids`. - /// /// # Arguments /// - /// * `room_id` - The room id of the DM room. - /// * `user_ids` - The user ids of the invitees for the DM room. + /// * `room_id` - The room ID of the direct message room. + /// * `user_ids` - The user IDs to be associated with this direct message + /// room. pub async fn mark_as_dm(&self, room_id: &RoomId, user_ids: &[OwnedUserId]) -> Result<()> { use ruma::events::direct::DirectEventContent;