diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2011-12-08 10:11:13 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2011-12-08 10:11:13 +0000 |
| commit | a357c6f3a23c604965d751cc13f2689d08aee81e (patch) | |
| tree | 242fce368cbb3f5db6d3c451a9b9e03b1e69206e /docs | |
| parent | 4eae37524bb6b08d1c369e6487f93ed4330f7815 (diff) | |
commands docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/commands.rst | 9 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/interface.rst | 1 |
3 files changed, 13 insertions, 3 deletions
diff --git a/docs/commands.rst b/docs/commands.rst index a59ceaf5..c2fb069f 100644 --- a/docs/commands.rst +++ b/docs/commands.rst @@ -3,6 +3,15 @@ Commands .. module:: alot.commands .. autoclass:: Command + :members: + +.. autoclass:: CommandParseError +.. autoclass:: CommandArgumentParser +.. autofunction:: commandfactory +.. autofunction:: lookup_command +.. autofunction:: lookup_parser +.. autoclass:: registerCommand + Globals -------- diff --git a/docs/index.rst b/docs/index.rst index 3e54ddf5..2864cad4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,9 +12,9 @@ Moreover, it integrates different "managers" responsible for core functionalitie * a :class:`~settings.AlotConfigParser` (subclasses :class:`configparser.ConfigParser`) for user settings * a :class:`~settings.HookManager` to load custom python code to be used as hooks -All user actions, triggered either by keybindings or the prompt, are given as commandline strings -that are translated into :class:`commands.Command` objects by -:func:`commands.commandfactory` and applied by :meth:`ui.UI.apply_command`. +Every user action, triggered either by keybindings or as input to the commandprompt, is +given as commandline string that gets :func:`translated <commands.commandfactory>` +to a :class:`~commands.Command` which is then :meth:`applied <ui.UI.apply_command>`. Different actions are defined as a subclasses of :class:`~commands.Command`, which live in `alot/commands/MODE.py`, where MODE is the name of the mode (:class:`Buffer` type) they are used in. diff --git a/docs/interface.rst b/docs/interface.rst index 3e6c9288..242fc7dd 100644 --- a/docs/interface.rst +++ b/docs/interface.rst @@ -45,6 +45,7 @@ input and acts on it: .. autoattribute:: logger .. autoattribute:: accountman + .. automethod:: apply_command .. automethod:: prompt .. automethod:: choice .. automethod:: notify |