commit 451295a: [Minor] Update docs

Vsevolod Stakhov vsevolod at highsecure.ru
Tue Jun 15 16:28:06 UTC 2021


Author: Vsevolod Stakhov
Date: 2021-06-15 17:27:38 +0100
URL: https://github.com/rspamd/rspamd/commit/451295abe4dc7604f64fdbd12a18884b2e8af400 (HEAD -> master)

[Minor] Update docs

---
 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 25e08e99a..eacf1bd15 100644
--- a/src/lua/lua_task.c
+++ b/src/lua/lua_task.c
@@ -219,9 +219,11 @@ LUA_FUNCTION_DEF (task, set_pre_result);
 
 /***
  * @method task:has_pre_result()
- * Returns true if task has some pre-result being set
+ * Returns true if task has some pre-result being set.
+ * If result has been set this function also returns pre result action,
+ * message and module as strings in this order.
  *
- * @return {boolean} true if task has some pre-result being set
+ * @return {boolean,[string,string,string]} true if task has some pre-result being set
  */
 LUA_FUNCTION_DEF (task, has_pre_result);
 /***


More information about the Commits mailing list