[Minor] Update docs

diff --git a/src/lua/lua_text.c b/src/lua/lua_text.c
index e10c34581ac35b24a2ef88d8042815be2e457ce7..ed1771feb2e168de93a87a944dfb5004cac9d9c3 100644 (file)
--- 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