X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=sid%2Fecho.py;h=96ea393d93c90180128f971c097d5fbea22bbbb0;hb=4a7f23317ab2236a85c3a17a00a52ac034c9bad7;hp=f19f7dc53f37ffe0f310c0e41b44e51aea94f0d5;hpb=38a5005a870abb3b53547bb80212d78e44eca67f;p=sid.git diff --git a/sid/echo.py b/sid/echo.py index f19f7dc..96ea393 100644 --- a/sid/echo.py +++ b/sid/echo.py @@ -17,8 +17,9 @@ from .plugin import Plugin, botcmd + class Echo(Plugin): - """Drop a message to be sent when someone gets online. + """Drops a message to be sent when someone gets online. """ def __init__(self, bot): @@ -30,10 +31,11 @@ class Echo(Plugin): # any presences you send yourself. To limit event handling # to a single room, use the events muc::room@server::presence, # muc::room@server::got_online, or muc::room@server::got_offline. - bot.add_event_handler("muc::%s::presence" % self.bot.room, self.log_presence) + bot.add_event_handler("muc::%s::presence" % + self.bot.room, self.log_presence) def log_presence(self, pres): - """Register presence""" + """Handler method registering MUC participants presence""" self.log.debug('%s: %s', pres['muc']['nick'], pres['type']) nick = pres['muc']['nick'] self.presence.update({nick: (pres['muc']['role'], pres['type'])}) @@ -47,9 +49,10 @@ class Echo(Plugin): @botcmd def tell(self, message, args): - """drop a message to be sent when someone gets online. - !tell queue : messages in queue - !tell : append to in queue""" + """Drops a message to be sent when someone gets online. + + * ``!tell queue`` : messages in queue + * ``!tell ``: append to in queue""" if not len(args): msg = 'Missing arguments:\n{}'.format(self.tell.__doc__) self.reply(message, msg)