From 03d86360d6425244399e3471f1d4950a762184bb Mon Sep 17 00:00:00 2001 From: "B. Petersen" Date: Fri, 9 Oct 2020 00:36:01 +0200 Subject: [PATCH] details docstring, thanks @flub --- src/chat.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/chat.rs b/src/chat.rs index 0b031d79e..e2eff0801 100644 --- a/src/chat.rs +++ b/src/chat.rs @@ -247,7 +247,13 @@ impl ChatId { .await } - /// Adds or sends out a protection-info-message. + /// Send protected status message to the chat. + /// + /// This sends the message with the protected status change to the chat, + /// notifying the user on this device as well as the other users in the chat. + /// If `promoted` is false this means the chat only exists on this device so far + /// and does not need to be sent out. + /// In this case an local info message is added to the chat. pub(crate) async fn add_protection_msg( self, context: &Context,