From cf29c371120929c53490d6017d5f43cf04f3cbc9 Mon Sep 17 00:00:00 2001
From: jesopo
Date: Thu, 23 May 2019 10:28:14 +0100
Subject: Add usage examples for all settings

---
 modules/github/__init__.py | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

(limited to 'modules/github/__init__.py')

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("#")
-- 
cgit v1.3.1-10-gc9f91