summaryrefslogtreecommitdiff
path: root/plugins/amsg.py
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-04-13 22:33:06 +0200
committermathieui <mathieui@mathieui.net>2013-04-13 22:33:06 +0200
commitd676c2ee7b6207ff0b2a7b384052ab07c08bf43a (patch)
treeb6c22d35da1eb5bc33ab0cc983a86d8dfe6c2a78 /plugins/amsg.py
parente6cb43eeedcd6c6961c5ab430f25bb962d40bf8e (diff)
downloadpoezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.gz
poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.bz2
poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.xz
poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.zip
Move the plugins documentation
(use automodule directive & docstrings)
Diffstat (limited to 'plugins/amsg.py')
-rw-r--r--plugins/amsg.py22
1 files changed, 21 insertions, 1 deletions
diff --git a/plugins/amsg.py b/plugins/amsg.py
index 57a37255..c330373f 100644
--- a/plugins/amsg.py
+++ b/plugins/amsg.py
@@ -1,5 +1,25 @@
-# A simple broadcast plugin
+"""
+This plugin broadcasts a message to all your joined rooms.
+.. note:: With great power comes great responsability.
+ Use with moderation.
+
+Installation
+------------
+You only have to load the plugin.::
+
+ /load amsg
+
+Command
+-------
+
+.. glossary::
+
+ /amsg
+ **Usage:** ``/amsg <message>``
+
+
+"""
from plugin import BasePlugin
from tabs import MucTab