mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-04-29 03:23:50 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify some doc comments.

Browse Source
This commit is contained in:
Denis Kasak
2024-02-12 16:52:00 +01:00
committed by Damir Jelić
parent ed5d97e052
commit 12444d3dc1
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
crates/matrix-sdk/src/account.rs
View File

@@ -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;