From 626ec5e793f8ff978432cddd95ee8219378ed637 Mon Sep 17 00:00:00 2001
From: link2xt <link2xt@testrun.org>
Date: Sun, 19 Feb 2023 13:05:39 +0000
Subject: [PATCH] Document the meaning of empty Message.subject

---
 src/chat.rs    | 2 +-
 src/message.rs | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/chat.rs b/src/chat.rs
index cc217af15..dd88cdd30 100644
--- a/src/chat.rs
+++ b/src/chat.rs
@@ -3397,7 +3397,7 @@ pub async fn forward_msgs(context: &Context, msg_ids: &[MsgId], chat_id: ChatId)
             msg.param.remove(Param::WebxdcSummaryTimestamp);
             msg.in_reply_to = None;
 
-            // do not leak data as group names; a default subject is generated by mimfactory
+            // do not leak data as group names; a default subject is generated by mimefactory
             msg.subject = "".to_string();
 
             let new_msg_id: MsgId;
diff --git a/src/message.rs b/src/message.rs
index 44d6c1194..688676253 100644
--- a/src/message.rs
+++ b/src/message.rs
@@ -265,6 +265,8 @@ pub struct Message {
     pub(crate) text: Option<String>,
 
     /// Message subject.
+    ///
+    /// If empty, a default subject will be generated when sending.
     pub(crate) subject: String,
 
     /// `Message-ID` header value.