summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-05-20 23:14:37 +0200
committermathieui <mathieui@mathieui.net>2013-05-20 23:14:37 +0200
commitab5a5f3aae2507e9124b7b9109f7f34251c14085 (patch)
treeb851618cb1826dbf4f3f8b29be6b3ca00b937771 /plugins
parent02559680491b467b8491dcee708a994304d2b9e4 (diff)
downloadpoezio-ab5a5f3aae2507e9124b7b9109f7f34251c14085.tar.gz
poezio-ab5a5f3aae2507e9124b7b9109f7f34251c14085.tar.bz2
poezio-ab5a5f3aae2507e9124b7b9109f7f34251c14085.tar.xz
poezio-ab5a5f3aae2507e9124b7b9109f7f34251c14085.zip
Add the documentation for the /tell plugin
Diffstat (limited to 'plugins')
-rw-r--r--plugins/tell.py28
1 files changed, 28 insertions, 0 deletions
diff --git a/plugins/tell.py b/plugins/tell.py
index d4d722af..c8437608 100644
--- a/plugins/tell.py
+++ b/plugins/tell.py
@@ -1,3 +1,31 @@
+"""
+The command added by this plugin sends a message to someone when he next joins.
+
+Installation
+------------
+You only have to load the plugin:
+
+
+``/load tell``
+
+Usage
+-----
+This plugin defines two new commands for MUC tabs: :term:`/tell` and :term:`/untell`.
+
+.. glossary::
+ :sorted:
+
+ /tell
+ *Usage*: ``/tell <nick> <message>``
+
+ Send *message* to *nick* at his next join.
+
+ /untell
+ *Usage:* ``/untell <nick>``
+
+ Cancel all scheduled messages to *nick*.
+
+"""
from plugin import BasePlugin
import tabs
import common