summaryrefslogtreecommitdiff
path: root/plugins/figlet.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/figlet.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/figlet.py')
-rw-r--r--plugins/figlet.py20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/figlet.py b/plugins/figlet.py
index eaf8dab3..9006f793 100644
--- a/plugins/figlet.py
+++ b/plugins/figlet.py
@@ -1,3 +1,23 @@
+"""
+This plugin uses figlet to transform every message into a big ascii-art
+message.
+
+Installation
+------------
+You only have to load the plugin (and have :file:`figlet` installed, of course).
+::
+
+ /load figlet
+
+
+Usage
+-----
+
+Say something in a Chat tab.
+
+.. note:: Can create fun things when used with :ref:`The rainbow plugin <rainbow-plugin>`.
+
+"""
from plugin import BasePlugin
import subprocess