Skip to content

Commit 4855ef9

Browse files
committed
Docs: fix syntax in filter expert bot documentation
1 parent a9e8d4e commit 4855ef9

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/user/bots.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2730,25 +2730,23 @@ A simple filter for messages (drop or pass) based on a exact string comparison o
27302730

27312731
**`filter_key`**
27322732

2733-
() - key from data format
2733+
(required, string) - key from data format
27342734

27352735
**`filter_value`**
27362736

2737-
() - value for the key
2737+
(required, string) - value for the key
27382738

27392739
**`filter_action`**
27402740

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

27442744
**`filter_regex`**
27452745

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

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

27532751
*Parameters for time based filtering*
27542752

0 commit comments

Comments
 (0)