diff options
| author |  jesopo | 2019-05-23 10:28:14 +0100 |
|---|---|---|
| committer | jesopo | 2019-05-23 10:28:14 +0100 |
| commit | cf29c371120929c53490d6017d5f43cf04f3cbc9 (patch) | |
| tree | fcdce0685aca7a7edb319b35589ecc4ce80edbd6 /modules/channel_op.py | |
| parent | `event.eat()` for command.regex hooks in github module (diff) | |
| signature | ||
Add usage examples for all settings
Diffstat (limited to 'modules/channel_op.py')
| -rw-r--r-- | modules/channel_op.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/modules/channel_op.py b/modules/channel_op.py index 9f9fab90..c3d8c022 100644 --- a/modules/channel_op.py +++ b/modules/channel_op.py @@ -7,15 +7,17 @@ class InvalidTimeoutException(Exception): @utils.export("channelset", {"setting": "highlight-spam-threshold", "help": "Set the number of nicknames in a message that qualifies as spam", - "validate": utils.int_or_none}) + "validate": utils.int_or_none, "example": "10"}) @utils.export("channelset", {"setting": "highlight-spam-protection", "help": "Enable/Disable highlight spam protection", - "validate": utils.bool_or_none}) + "validate": utils.bool_or_none, "example": "on"}) @utils.export("channelset", {"setting": "highlight-spam-ban", "help": "Enable/Disable banning highlight spammers " - "instead of just kicking", "validate": utils.bool_or_none}) + "instead of just kicking", "validate": utils.bool_or_none, + "example": "on"}) @utils.export("channelset", {"setting": "ban-format", - "help": "Set ban format ($n = nick, $u = username, $h = hostname)"}) + "help": "Set ban format ($n = nick, $u = username, $h = hostname)", + "example": "*!$u@$h"}) class Module(ModuleManager.BaseModule): _name = "ChanOp" |