summaryrefslogtreecommitdiff
path: root/plugins/tell.py
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/tell.py')
-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