diff options
| author | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2021-07-12 20:09:25 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-12 20:09:25 +0100 |
| commit | 43a08250eded9ef853d5d20587a8afb547f39de3 (patch) | |
| tree | 014673f563b847f1102e22e8f3b01bed83425781 /src/lua/lua_mimepart.c | |
| parent | 6adab61b4aee60efb5176d4f599281e09866b671 (diff) | |
| parent | 35f3ab12200bb9202ccbaa3ed0160be206d32a6f (diff) | |
| download | rspamd-43a08250eded9ef853d5d20587a8afb547f39de3.tar.gz rspamd-43a08250eded9ef853d5d20587a8afb547f39de3.zip | |
Merge pull request #3815 from jendis/changedoc
[Minor] rewrite doc of text_part:get_fuzzy_hashes method
Diffstat (limited to 'src/lua/lua_mimepart.c')
| -rw-r--r-- | src/lua/lua_mimepart.c | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/src/lua/lua_mimepart.c b/src/lua/lua_mimepart.c index 971aa18eb..66b588e3a 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); |