From: Anton Yuzhaninov <citrin+git@citrin.ru>
Date: Tue, 18 Aug 2020 12:21:27 +0000 (+0100)
Subject: [Doc] Improve task:get_message_id() description
X-Git-Tag: 2.6~148^2
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=refs%2Fpull%2F3472%2Fhead;p=rspamd.git

[Doc] Improve task:get_message_id() description
---

diff --git a/src/lua/lua_task.c b/src/lua/lua_task.c
index e850f1d7e..27fee395d 100644
--- a/src/lua/lua_task.c
+++ b/src/lua/lua_task.c
@@ -774,8 +774,10 @@ end
 LUA_FUNCTION_DEF (task, get_date);
 /***
  * @method task:get_message_id()
- * Returns message id of the specified task
- * @return {string} if of a message
+ * Returns message identifier from the `Message-ID` header.  Angle brackets (`<>`)
+ * are stripped off if present.  If a Message-ID header is missing `undef` is
+ * returned.
+ * @return {string} ID of the message
  */
 LUA_FUNCTION_DEF (task, get_message_id);
 /***