Adding help functions to the spacebot modules

Author: realitygaps

checkin.py

@@ -26,7 +26,9 @@ def trackstate(bot):
         WHO = []
 
 @willie.module.commands('checkin')
+@willie.module.example('.checkin','checkin')
 def checkin(bot, trigger):
+  """Adds you in to the list of people currently in the space"""
   global WHO
   if trigger.nick in WHO:
     bot.say(trigger.nick + ' is already checked in')
@@ -35,7 +37,9 @@ def checkin(bot, trigger):
     bot.say(trigger.nick + ' is now checked in')
 
 @willie.module.commands('checkout')
+@willie.module.example('.checkout','checkout')
 def checkout(bot, trigger):
+  """Removes you from the list of people currently in the space"""
   global WHO
   if trigger.nick in WHO:
     WHO.remove(trigger.nick)
@@ -44,13 +48,17 @@ def checkout(bot, trigger):
     bot.say(trigger.nick + ' was not checked in')
 
 @willie.module.commands('emptylist')
+@willie.module.example('.emptylist','emptylist')
 def emptylist(bot, trigger):
+  """Emptys the list of people currently checked in at the space"""
   global WHO
   WHO = []
   bot.say('Check-in list has been emptied')
 
 @willie.module.commands('who')
+@willie.module.example('.who','who')
 def checkwho(bot, trigger):
+  """Returns the list of people currently checked in at the space"""
   global WHO
   peoplelist = ''
   if not WHO:
@@ -61,13 +69,17 @@ def checkwho(bot, trigger):
     bot.say(peoplelist)
 
 @willie.module.commands('anoncheckin')
+@willie.module.example('.anoncheckin','anoncheckin')
 def anoncheckin(bot, trigger):
+  """Adds an anonymous user to the list of people currently checked in at the space"""
   global WHO
   WHO.append('anonymous')
   bot.say('anonymous is now checked in')
 
 @willie.module.commands('anoncheckout')
+@willie.module.commands('.anoncheckout','anoncheckout')
 def anoncheckout(bot, trigger):
+  """Removes an anonymous user from the list of people currently checked in at the space"""
   global WHO
   if 'anonymous' in WHO:
     WHO.remove('anonymous')

flashlights.py

@@ -4,7 +4,9 @@
 from willie.module import commands, interval
 
 @willie.module.commands('alertspace')
+@willie.module.example('.alertspace','alertspace')
 def spacestate(bot, trigger):
+  """Alerts the space by flashing the lights a few times"""
   opener = urllib2.build_opener(urllib2.HTTPHandler)
   request = urllib2.Request('http://10.0.20.32/api/0123456789abdcef0123456789abcdef/groups/0/action', data='{    "alert": "lselect" }')
   request.add_header('Content-Type', 'text/json')

spaceevents.py

@@ -30,11 +30,15 @@ def getevents(bot, number):
     bot.say(stuff[0] + " - " + stuff[1])
 
 @willie.module.commands('nextevents')
+@willie.module.example('.nextevents','nextevents')
 def eve(bot, trigger):
+  """Returns a list of the next events at the space"""
   eventnum = trigger.group(2)
   getevents(bot, 3)
 
 @willie.module.commands('nextevent')
+@willie.module.example('.nextevent','nextevent')
 def nexteve(bot, trigger):
+  """Returns the next event at the space"""
   getevents(bot, 1)
 

spacempd.py

@@ -10,7 +10,9 @@
 PASSWORD = 'password goes here'
 
 @willie.module.commands('mpd')
+@willie.module.example('.mpd playing or .mpd play or .mpd next','mpdplaying')
 def mpd(bot, trigger):
+  """Used to control the mpd music player at the space"""
   rulenum = trigger.group(2)
 
   ## MPD object instance

spacerules.py

@@ -24,7 +24,9 @@ def getrules():
   return therules
 
 @willie.module.commands('rule')
+@willie.module.example('.rule 34','rule')
 def rule(bot, trigger):
+  """Returns a techinc rule from the wiki of the number specified"""
   rulenum = trigger.group(2)
   therules = getrules()
   try:

spacestate.py

@@ -10,7 +10,9 @@
 import urllib2
 
 @willie.module.commands('spacestate')
+@willie.module.example('.spacestate', 'Spacestate')
 def spacestate(bot, trigger):
+  """Replies with the current space state - Open/Closed"""
   response = urllib2.urlopen('http://techinc.nl/space/spacestate')
   html = response.read()
   bot.say('The space is currently ' + html)

spacestatechange.py

@@ -36,7 +36,9 @@ def trackstate(bot):
         SPACESTATE = state
 
 @willie.module.commands('togglestate')
+@willie.module.example('.togglestate','togglestate')
 def togglestate(bot, trigger):
+  """Toggles the state of the space (open/closed)"""
   currentstate = checkstate()
   bot.say('Changing Spacestate')
   if currentstate == 'open':
@@ -46,7 +48,9 @@ def togglestate(bot, trigger):
   changestate(state)
 
 @willie.module.commands('spacestate')
+@willie.module.example('.spacestate', 'spacestate')
 def spacestate(bot, trigger):
+  """Returns the current state of the space (open/closed)"""
   global SPACEURL
   response = urllib2.urlopen(SPACEURL)
   html = response.read()