Browse files

Update "u" help comments

  • Loading branch information...
1 parent 1f86fe1 commit 372727e3f33f39fdf12400bcc9c23d8fff1bca6a @technicalpickles technicalpickles committed Jun 9, 2012
Showing with 58 additions and 14 deletions.
  1. +13 −5 src/scripts/uptime-robot.coffee
  2. +14 −1 src/scripts/uptime.coffee
  3. +15 −5 src/scripts/urban.coffee
  4. +14 −3 src/scripts/url.coffee
  5. +2 −0 src/scripts/whatis.coffee
View
18 src/scripts/uptime-robot.coffee
@@ -1,10 +1,18 @@
-# Show uptime status of sites monitored by uptime robot.
+# Description:
+# Show uptime status of sites monitored by UptimeRobot.
#
-# You need to set the following variables:
-# HUBOT_UPTIMEROBOT_APIKEY = <apikey>
+# Dependencies:
+# None
#
-# hubot what is the uptime of the monitored sites? -- Show the status of the monitored sites
-# hubot start monitoring the http uptime of <url> -- Instructs uptime robot to monitor the <url>
+# Configuration:
+# HUBOT_UPTIMEROBOT_APIKEY
+#
+# Commands:
+# hubot what is the uptime of the monitored sites? - Show the status of the monitored sites
+# hubot start monitoring the http uptime of <url> - Instructs uptime robot to monitor the <url>
+#
+# Author:
+# lukesmith
module.exports = (robot) ->
apikey = process.env.HUBOT_UPTIMEROBOT_APIKEY
View
15 src/scripts/uptime.coffee
@@ -1,4 +1,17 @@
-# Outputs bot uptime
+# Description:
+# None
+#
+# Dependencies:
+# None
+#
+# Configuration:
+# None
+#
+# Commands:
+# hubot uptime - Outputs bot uptime
+#
+# Author:
+# whitman
module.exports = (robot) ->
View
20 src/scripts/urban.coffee
@@ -1,11 +1,21 @@
-# Define terms via Urban Dictionary
+# Description:
+# Define terms via Urban Dictionary
#
-# — Travis Jeffery (@travisjeffery)
+# Dependencies:
+# None
#
-# urban me <term> - Searches Urban Dictionary and returns definition
-# urban define me <term> - Searches Urban Dictionary and returns definition
-# urban example me <term> - Searches Urban Dictionary and returns example
+# Configuration:
+# None
+#
+# Commands:
+# hubot urban me <term> - Searches Urban Dictionary and returns definition
+# hubot urban define me <term> - Searches Urban Dictionary and returns definition
+# hubot urban example me <term> - Searches Urban Dictionary and returns example
+#
+# Author:
+# Travis Jeffery (@travisjeffery)
+# FIXME merge with whatis.coffee
module.exports = (robot) ->
robot.respond /(urban)( define)?( example)?( me)? (.*)/i, (msg) ->
View
17 src/scripts/url.coffee
@@ -1,7 +1,18 @@
-# URL encoding and decoding.
+# Description:
+# URL encoding and decoding
#
-# hubot url encode|decode <query> - URL encode or decode <string>
-# hubot url form encode|decode <query> - URL form-data encode or decode <string>
+# Dependencies:
+# None
+#
+# Configuration:
+# None
+#
+# Commands:
+# hubot url encode|decode <query> - URL encode or decode <string>
+# hubot url form encode|decode <query> - URL form-data encode or decode <string>
+#
+# Author:
+# jimeh
module.exports = (robot) ->
robot.respond /URL encode( me)? (.*)/i, (msg) ->
View
2 src/scripts/whatis.coffee
@@ -12,6 +12,8 @@
#
# Author:
# Kevin Qiu
+#
+# FIXME merge with urban.coffee
jsdom = require('jsdom').jsdom

0 comments on commit 372727e

Please sign in to comment.