diff options
Diffstat (limited to 'docs/source/configuration/hooks.rst')
| -rw-r--r-- | docs/source/configuration/hooks.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst index 6e7162e8..352701c3 100644 --- a/docs/source/configuration/hooks.rst +++ b/docs/source/configuration/hooks.rst @@ -205,3 +205,10 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: :type suffix: str :returns: tuple of `prefix` and `suffix` :rtype: (str, str) + +.. py:function:: loop_hook(ui=None) + + Run on a period controlled by :ref:`_periodic_hook_frequency <periodic-hook-frequency>` + + :param ui: the main user interface + :type ui: :class:`alot.ui.UI` |