diff options
author | mathieui <mathieui@mathieui.net> | 2013-04-13 22:33:06 +0200 |
---|---|---|
committer | mathieui <mathieui@mathieui.net> | 2013-04-13 22:33:06 +0200 |
commit | d676c2ee7b6207ff0b2a7b384052ab07c08bf43a (patch) | |
tree | b6c22d35da1eb5bc33ab0cc983a86d8dfe6c2a78 /plugins/reminder.py | |
parent | e6cb43eeedcd6c6961c5ab430f25bb962d40bf8e (diff) | |
download | poezio-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/reminder.py')
-rw-r--r-- | plugins/reminder.py | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/plugins/reminder.py b/plugins/reminder.py index 16a3f710..eb2f9801 100644 --- a/plugins/reminder.py +++ b/plugins/reminder.py @@ -1,3 +1,60 @@ +""" +Installation +------------ +You only have to load the plugin: + +.. code-block:: none + + /load reminder + +Usage +----- + +This plugin defines three new global commands: :term:`/remind`, +:term:`/done`, and :term:`/tasks`. + +.. glossary:: + + /remind + **Usage:** ``/remind <time> <todo>`` + + This command will remind you to do ``todo`` every ``time``. + + /done + **Usage:** ``/done <id>`` + Remove a reminder. + + The ``id`` is found using :term:`/tasks`. + + + /tasks + + Print a list of the tasks, their ids, and their frequency, into the + information buffer. + +Time format +----------- + +In seconds: + +.. code-block:: none + + /remind 600 Work! + +Will remind you to work every 10 minutes. + +Defining the time in seconds is not really practical, so you can describe it +with days, hours, and minutes, in a time-string, e.g: + +.. code-block:: python + + /remind 1h23m "Get up" + +Will remind you to get up every 1 hour 23 minutes. + + +""" + from plugin import BasePlugin import curses import common |