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/ducks.py | |
| parent | `event.eat()` for command.regex hooks in github module (diff) | |
Add usage examples for all settings
Diffstat (limited to 'modules/ducks.py')
| -rw-r--r-- | modules/ducks.py | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/modules/ducks.py b/modules/ducks.py index 072bbb57..a2eb4a7a 100644 --- a/modules/ducks.py +++ b/modules/ducks.py @@ -7,13 +7,14 @@ NO_DUCK = "There was no duck!" DEFAULT_MIN_MESSAGES = 100 @utils.export("channelset", {"setting": "ducks-enabled", - "help": "Whether or not to spawn ducks", "validate": utils.bool_or_none}) + "help": "Whether or not to spawn ducks", "validate": utils.bool_or_none, + "example": "on"}) @utils.export("channelset", {"setting": "ducks-min-messages", "help": "Minimum messages between ducks spawning", - "validate": utils.int_or_none}) + "validate": utils.int_or_none, "example": "50"}) @utils.export("channelset", {"setting": "ducks-kick", "help": "Whether or not to kick someone talking to non-existent ducks", - "validate": utils.bool_or_none}) + "validate": utils.bool_or_none, "example": "on"}) class Module(ModuleManager.BaseModule): @utils.hook("new.channel") def new_channel(self, event): |