From: Jan Smutny <js@excello.cz>
Date: Fri, 9 Jul 2021 12:28:42 +0000 (+0200)
Subject: [Minor] rewrite doc of text_part:get_fuzzy_hashes method
X-Git-Tag: 3.0~172^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F3815%2Fhead;p=thirdparty%2Frspamd.git

[Minor] rewrite doc of text_part:get_fuzzy_hashes method
---

diff --git a/src/lua/lua_mimepart.c b/src/lua/lua_mimepart.c
index 9cc1374beb..0e74eafc06 100644
--- a/src/lua/lua_mimepart.c
+++ b/src/lua/lua_mimepart.c
@@ -209,11 +209,9 @@ LUA_FUNCTION_DEF (textpart, get_languages);
 /***
  * @method text_part:get_fuzzy_hashes(mempool)
  * @param {rspamd_mempool} mempool - memory pool (usually task pool)
- * Returns direct hash + array of shingles being calculated as following:
- * - [1] - fuzzy digest as a string
- * - [2..33] - fuzzy hashes as the following tables:
- *   - [1] - 64 bit integer represented as a string
- *   - [2..4] - strings used to generate this hash
+ * Returns direct hash of textpart as a string and array [1..32] of shingles each represented as a following table:
+ * - [1] - 64 bit fuzzy hash represented as a string
+ * - [2..4] - strings used to generate this hash
  * @return {string,array|tables} fuzzy hashes calculated
  */
 LUA_FUNCTION_DEF (textpart, get_fuzzy_hashes);