aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2020-01-20 12:37:07 +0000
committerVsevolod Stakhov <vsevolod@highsecure.ru>2020-01-20 12:37:07 +0000
commit978f5e47d0607832c9f832b9708452b9f9d4e2fb (patch)
tree451afac20184a7e2fdddb10c7385e2c421ee4832 /src
parent0099c72784972169ae1bd37b5e4b3b5dc7b0d02f (diff)
downloadrspamd-978f5e47d0607832c9f832b9708452b9f9d4e2fb.tar.gz
rspamd-978f5e47d0607832c9f832b9708452b9f9d4e2fb.zip
[Minor] Update docs
Diffstat (limited to 'src')
-rw-r--r--src/lua/lua_text.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/lua/lua_text.c b/src/lua/lua_text.c
index e10c34581..ed1771feb 100644
--- a/src/lua/lua_text.c
+++ b/src/lua/lua_text.c
@@ -107,6 +107,14 @@ LUA_FUNCTION_DEF (text, take_ownership);
* @method rspamd_text:exclude_chars(set_to_exclude, [always_copy])
* Returns a text (if owned, then the original text is modified, if not, then it is copied and owned)
* where all chars from `set_to_exclude` are removed
+ * Patterns supported:
+ *
+ * - %s - all space characters
+ * - %n - all newline characters
+ * - %c - all control characters (it includes 8bit characters and spaces)
+ * - %8 - all 8 bit characters
+ * - %% - just a percent character
+ *
* @param {string} set_to_exclude characters to exclude
* @param {boolean} always_copy always copy the source text
* @return {tspamd_text} modified or copied text