From 4eb8d3fef62761a359e6acf1c34716bfd9261208 Mon Sep 17 00:00:00 2001 From: "B. Petersen" Date: Fri, 9 Oct 2020 00:28:44 +0200 Subject: [PATCH] tweak documentation towards https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text - thanks @flub --- src/chat.rs | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/chat.rs b/src/chat.rs index 304c455cf..0b031d79e 100644 --- a/src/chat.rs +++ b/src/chat.rs @@ -174,7 +174,8 @@ impl ChatId { self.set_blocked(context, Blocked::Not).await; } - /// Set protection without sending a message. + /// Sets protection without sending a message. + /// /// Used when a message arrives indicating that someone else has /// changed the protection value for a chat. pub(crate) async fn inner_set_protection( @@ -226,7 +227,7 @@ impl ChatId { Ok(()) } - /// returns a stock message saying that protection status has changed. + /// Returns a stock message saying that protection status has changed. pub(crate) async fn get_protection_msg( self, context: &Context, @@ -246,7 +247,7 @@ impl ChatId { .await } - /// adds or sends out a protection-info-message + /// Adds or sends out a protection-info-message. pub(crate) async fn add_protection_msg( self, context: &Context, @@ -272,7 +273,7 @@ impl ChatId { Ok(()) } - /// Set protection and sends or adds a message. + /// Sets protection and sends or adds a message. pub async fn set_protection( self, context: &Context,