X-Git-Url: http://git.kaliko.me/?p=sid.git;a=blobdiff_plain;f=sid%2Fplugin.py;h=6db1d5984f07875af599dd694393ba0aeb8f69c2;hp=6ff12eed45f01194df1597082f105d8519c3a242;hb=1c1134e00f13fee92f9a0e0996d08db32579d89a;hpb=dbc1b2e6149234b8571425b6684a2858fa52c545
diff --git a/sid/plugin.py b/sid/plugin.py
index 6ff12ee..6db1d59 100644
--- a/sid/plugin.py
+++ b/sid/plugin.py
@@ -18,9 +18,13 @@
from .sid import botcmd
class Plugin:
- """Simple Plugin object to derive from:
- Exposes the bot object and its logger
- Provides some send helpers
+ """
+ Simple Plugin object to derive from:
+
+ * Exposes the bot object and its logger
+ * Provides send helpers
+
+ :param sid.sid.MUCBot bot: bot the plugin is load from
"""
def __init__(self, bot):
@@ -29,10 +33,17 @@ class Plugin:
def send(self, dest, msg, mtype='chat'):
"""Send msg to dest
- msg = {
- mbody: 'text',
- mhtml: 'text, # optional'
- }
+
+ :param str dest: Message recipient
+ :param dict,str msg: Message to send (use dict for xhtml-im)
+
+ .. note::
+ if **msg** is a :py:obj:`dict` to provide xhmlt-im massages::
+
+ msg = {
+ mbody: 'text',
+ mhtml: 'text, # optional'
+ }
"""
if isinstance(msg, str):
msg = {'mbody': msg}
@@ -43,7 +54,11 @@ class Plugin:
def reply(self, rcv, msg):
"""Smart reply to message received.
- Replies in private or on the muc depending on
+
+ Replies ``msg`` in private or on the muc depending on ``rcv``
+
+ :param rcv: The received message (slixmpp object)
+ :param dict,str msg: The message to reply, refer to :py:obj:`sid.plugin.Plugin.send` for ``msg`` format
"""
to = rcv['from']
if rcv['type'] == 'groupchat':