diff options
| author | Lucas Hoffmann <l-m-h@web.de> | 2017-01-26 12:22:18 +0100 |
|---|---|---|
| committer | Lucas Hoffmann <l-m-h@web.de> | 2017-01-26 21:21:59 +0100 |
| commit | 9822e0818cefce64890b400fb4273d1de4fc40aa (patch) | |
| tree | 83a65f8151ed5301a40eb1a687c1d1eba7677590 /docs | |
| parent | 668c5d3b9a108841d7aca60e47fd3a65074976e7 (diff) | |
Wrap long lines
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/configuration/hooks.rst | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst index 7577e87a..a8bd71d4 100644 --- a/docs/source/configuration/hooks.rst +++ b/docs/source/configuration/hooks.rst @@ -2,8 +2,8 @@ Hooks ===== -Hooks are python callables that live in a module specified by `hooksfile` in the -config. Per default this points to :file:`~/.config/alot/hooks.py`. +Hooks are python callables that live in a module specified by `hooksfile` in +the config. Per default this points to :file:`~/.config/alot/hooks.py`. .. rubric:: Pre/Post Command Hooks @@ -24,7 +24,8 @@ looks like this: :param cmd: the Command instance that is being called :type cmd: :class:`alot.commands.Command` -Consider this pre-hook for the exit command, that logs a personalized goodbye message:: +Consider this pre-hook for the exit command, that logs a personalized goodbye +message:: import logging from alot.settings import settings @@ -42,7 +43,8 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: .. py:function:: reply_prefix(realname, address, timestamp[, ui= None, dbm=None]) Is used to reformat the first indented line in a reply message. - This defaults to 'Quoting %s (%s)\n' % (realname, timestamp)' unless this hook is defined + This defaults to 'Quoting %s (%s)\n' % (realname, timestamp)' unless this + hook is defined :param realname: name or the original sender :type realname: str @@ -55,7 +57,8 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: .. py:function:: forward_prefix(realname, address, timestamp[, ui= None, dbm=None]) Is used to reformat the first indented line in a inline forwarded message. - This defaults to 'Forwarded message from %s (%s)\n' % (realname, timestamp)' if this hook is undefined + This defaults to 'Forwarded message from %s (%s)\n' % (realname, + timestamp)' if this hook is undefined :param realname: name or the original sender :type realname: str @@ -69,7 +72,8 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: used to manipulate a messages bodytext *before* the editor is called. - :param bodytext: text representation of mail body as displayed in the interface and as sent to the editor + :param bodytext: text representation of mail body as displayed in the + interface and as sent to the editor :type bodytext: str :rtype: str @@ -77,7 +81,8 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: used to manipulate a messages bodytext *after* the editor is called - :param bodytext: text representation of mail body as displayed in the interface and as sent to the editor + :param bodytext: text representation of mail body as displayed in the + interface and as sent to the editor :type bodytext: str :rtype: str |