From 065c7af9a093876d5a610c011e956f9984db19cd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20Kl=C3=A4hn?=
 <39526136+Septias@users.noreply.github.com>
Date: Tue, 6 Sep 2022 11:15:49 +0200
Subject: [PATCH] Fix typos & add documentation (#3569)

* fix typo

* tips & typos

* improve doc string

* update documentation

* fmt

* fix typo
---
 src/chat.rs        | 2 +-
 src/mimefactory.rs | 2 ++
 src/param.rs       | 2 +-
 3 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/chat.rs b/src/chat.rs
index f681f55a7..f2927a6b6 100644
--- a/src/chat.rs
+++ b/src/chat.rs
@@ -2863,7 +2863,7 @@ pub async fn remove_contact_from_chat(
     let mut success = false;
 
     /* we do not check if "contact_id" exists but just delete all records with the id from chats_contacts */
-    /* this allows to delete pending references to deleted contacts.  Of course, this should _not_ happen. */
+    /* this allows to delete pending references to deleted contacts. Of course, this should _not_ happen. */
     if let Ok(chat) = Chat::load_from_db(context, chat_id).await {
         if chat.typ == Chattype::Group || chat.typ == Chattype::Broadcast {
             if !chat.is_self_in_chat(context).await? {
diff --git a/src/mimefactory.rs b/src/mimefactory.rs
index dab72d521..ed7f3cf65 100644
--- a/src/mimefactory.rs
+++ b/src/mimefactory.rs
@@ -445,6 +445,8 @@ impl<'a> MimeFactory<'a> {
             .collect()
     }
 
+    /// Consumes a `MimeFactory` and renders it into a message which is then stored in
+    /// `smtp`-table to be used by the SMTP loop
     pub async fn render(mut self, context: &Context) -> Result<RenderedEmail> {
         let mut headers: MessageHeaders = Default::default();
 
diff --git a/src/param.rs b/src/param.rs
index d2739ec08..44c81e598 100644
--- a/src/param.rs
+++ b/src/param.rs
@@ -163,7 +163,7 @@ pub enum Param {
     /// For Chats: timestamp of group name update.
     GroupNameTimestamp = b'g',
 
-    /// For Chats: timestamp of group name update.
+    /// For Chats: timestamp of member list update.
     MemberListTimestamp = b'k',
 
     /// For Chats: timestamp of protection settings update.