From: Vsevolod Stakhov <vsevolod@highsecure.ru>
Date: Mon, 20 Jan 2020 12:37:07 +0000 (+0000)
Subject: [Minor] Update docs
X-Git-Tag: 2.3~75
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=978f5e47d0607832c9f832b9708452b9f9d4e2fb;p=rspamd.git

[Minor] Update docs
---

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