commit 72f0f0d: [Doc] Improve task:get_message_id() description

[Anton Yuzhaninov]

Author: Anton Yuzhaninov
Date: 2020-08-18 13:21:27 +0100
URL: https://github.com/rspamd/rspamd/commit/72f0f0ddd3017f5be7bfe19fe5d2abe2dcf95629 (refs/pull/3472/head)

[Doc] Improve task:get_message_id() description

---
 src/lua/lua_task.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

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);
 /***