summaryrefslogtreecommitdiff
path: root/plugins/screen_detach.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/screen_detach.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/screen_detach.py')
-rw-r--r--plugins/screen_detach.py12
1 files changed, 12 insertions, 0 deletions
diff --git a/plugins/screen_detach.py b/plugins/screen_detach.py
index 6ee96896..2cc55cd6 100644
--- a/plugins/screen_detach.py
+++ b/plugins/screen_detach.py
@@ -1,3 +1,15 @@
+"""
+This plugin will set your status to **away** if you detach your screen.
+
+Installation
+------------
+You only have to load the plugin.
+
+.. code-block:: none
+
+ /load screen_detach
+
+"""
from plugin import BasePlugin
import os
import stat