diff options
| author | Jan Smutny <js@excello.cz> | 2021-07-09 14:28:42 +0200 |
|---|---|---|
| committer | Jan Smutny <js@excello.cz> | 2021-07-09 14:28:42 +0200 |
| commit | 35f3ab12200bb9202ccbaa3ed0160be206d32a6f (patch) | |
| tree | 03dd5007081b488573d7608750d5de97dc7b16b0 /src/lua/lua_mimepart.c | |
| parent | 4c56c1210dac78be727fc07d1c29c140034e4b19 (diff) | |
| download | rspamd-35f3ab12200bb9202ccbaa3ed0160be206d32a6f.tar.gz rspamd-35f3ab12200bb9202ccbaa3ed0160be206d32a6f.zip | |
[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 9cc1374be..0e74eafc0 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); |