summaryrefslogtreecommitdiff
path: root/plugins/status.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/status.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/status.py')
-rw-r--r--plugins/status.py35
1 files changed, 35 insertions, 0 deletions
diff --git a/plugins/status.py b/plugins/status.py
index c3e0aa7b..9926ffc8 100644
--- a/plugins/status.py
+++ b/plugins/status.py
@@ -1,3 +1,38 @@
+"""
+This plugin adds several aliases, to shorten status changes.
+
+Installation
+------------
+You only have to load the plugin.
+
+.. code-block:: none
+
+ /load status
+
+Aliases
+-------
+
+.. glossary::
+ :sorted:
+
+ /afk
+ /away
+ Set your status to ``away``
+
+ /dnd
+ /busy
+ Set your status to ``dnd``
+
+ /available
+ Set your status to ``available``
+
+ /chat
+ Set your status to ``chat``
+
+ /xa
+ Set your status to ``xa``
+
+"""
from plugin import BasePlugin
class Plugin(BasePlugin):