Skip to content

Commit

Permalink
Docs: fix syntax in filter expert bot documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sebix committed May 10, 2024
1 parent 63a0209 commit 1822327
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/user/bots.md
Original file line number Diff line number Diff line change
Expand Up @@ -2726,25 +2726,23 @@ A simple filter for messages (drop or pass) based on a exact string comparison o

**`filter_key`**

() - key from data format
(required, string) - key from data format

**`filter_value`**

() - value for the key
(required, string) - value for the key

**`filter_action`**

() - action when a message match to the criteria
(required, string) - action when a message match to the criteria
(possible actions: keep/drop)

**`filter_regex`**

() - attribute determines if the `filter_value` shall be treated as regular expression or not.
(optional, boolean) - attribute determines if the `filter_value` shall be treated as regular expression or not.

If this attribute is not empty (can be `true`, `yes` or whatever), the bot uses python's `` `re.search ``
<<https://docs.python.org/3/library/re.html#re.search>>`_ function to evaluate the filter with regular expressions. If
this attribute is empty or evaluates to false, an exact string comparison is performed. A check on string *
inequality* can be achieved with the usage of *Paths* described below.
If this attribute is not empty (can be `true`, `yes` or whatever), the bot uses python's [`re.search`](https://docs.python.org/3/library/re.html#re.search) function to evaluate the filter with regular expressions. If
this attribute is empty or evaluates to false, an exact string comparison is performed. A check on string *inequality* can be achieved with the usage of *Paths* described below.

*Parameters for time based filtering*

Expand Down

0 comments on commit 1822327

Please sign in to comment.