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/github | |
| parent | `event.eat()` for command.regex hooks in github module (diff) | |
| signature | ||
Add usage examples for all settings
Diffstat (limited to 'modules/github')
| -rw-r--r-- | modules/github/__init__.py | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/modules/github/__init__.py b/modules/github/__init__.py index 46f8be27..68228f62 100644 --- a/modules/github/__init__.py +++ b/modules/github/__init__.py @@ -93,18 +93,19 @@ CHECK_RUN_FAILURES = ["failure", "cancelled", "timed_out", "action_required"] @utils.export("channelset", {"setting": "github-hide-prefix", "help": "Hide/show command-like prefix on Github hook outputs", - "validate": utils.bool_or_none}) + "validate": utils.bool_or_none, "example": "on"}) @utils.export("channelset", {"setting": "github-hide-organisation", "help": "Hide/show organisation in repository names", - "validate": utils.bool_or_none}) + "validate": utils.bool_or_none, "example": "on"}) @utils.export("channelset", {"setting": "github-default-repo", - "help": "Set the default github repo for the current channel"}) + "help": "Set the default github repo for the current channel", + "example": "jesopo/bitbot"}) @utils.export("channelset", {"setting": "github-prevent-highlight", "help": "Enable/disable preventing highlights", - "validate": utils.bool_or_none}) + "validate": utils.bool_or_none, "example": "on"}) @utils.export("channelset", {"setting": "auto-github", "help": "Enable/disable automatically getting github issue/PR info", - "validate": utils.bool_or_none}) + "validate": utils.bool_or_none, "example": "on"}) class Module(ModuleManager.BaseModule): def _parse_ref(self, channel, ref): repo, _, number = ref.rpartition("#") |