From 44bd9f93b486313105b405135ab6584748fc6668 Mon Sep 17 00:00:00 2001
From: link2xt <link2xt@testrun.org>
Date: Sat, 31 Jul 2021 22:42:14 +0300
Subject: [PATCH] job: fix delete_msg_on_imap documentation

---
 src/job.rs | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/src/job.rs b/src/job.rs
index 2b7da407a..387012ddf 100644
--- a/src/job.rs
+++ b/src/job.rs
@@ -590,12 +590,13 @@ impl Job {
 
     /// Deletes a message on the server.
     ///
-    /// foreign_id is a MsgId pointing to a message in the trash chat
-    /// or a hidden message.
+    /// `foreign_id` is a MsgId.
     ///
-    /// This job removes the database record. If there are no more
-    /// records pointing to the same message on the server, the job
-    /// also removes the message on the server.
+    /// If the message is in the trash chat or hidden, this job
+    /// removes database record, otherwise it only clears the
+    /// `server_uid` column.  If there are no more records pointing to
+    /// the same message on the server, the job actually removes the
+    /// message on the server.
     async fn delete_msg_on_imap(&mut self, context: &Context, imap: &mut Imap) -> Status {
         if let Err(err) = imap.prepare(context).await {
             warn!(context, "could not connect: {:?}", err);