diff options
| author | Lucas Hoffmann <l-m-h@web.de> | 2017-01-26 12:31:16 +0100 |
|---|---|---|
| committer | Lucas Hoffmann <l-m-h@web.de> | 2017-01-26 21:21:59 +0100 |
| commit | b22e9d7ac7af361ea5c7e40eb9d20e2d18e58210 (patch) | |
| tree | 31cde27e46b07d990ad5ba876a5a16fcab113d19 /docs/source/configuration | |
| parent | 9822e0818cefce64890b400fb4273d1de4fc40aa (diff) | |
Clarify docs for {pr,post}_edit_translate hooks
Diffstat (limited to 'docs/source/configuration')
| -rw-r--r-- | docs/source/configuration/hooks.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst index a8bd71d4..bf87a42d 100644 --- a/docs/source/configuration/hooks.rst +++ b/docs/source/configuration/hooks.rst @@ -68,9 +68,14 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: :type timestamp: :obj:`datetime.datetime` :rtype: string +.. _pre-edit-translate: + .. py:function:: pre_edit_translate(bodytext[, ui= None, dbm=None]) - used to manipulate a messages bodytext *before* the editor is called. + Used to manipulate a messages bodytext *before* the editor is called. The + bodytext might also contain some header lines, depending on the settings + :ref:`edit_headers_whitelist <edit-headers-whitelist>` and + :ref:`edit_header_blacklist <edit-headers-blacklist>`. :param bodytext: text representation of mail body as displayed in the interface and as sent to the editor @@ -79,7 +84,8 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: .. py:function:: post_edit_translate(bodytext[, ui= None, dbm=None]) - used to manipulate a messages bodytext *after* the editor is called + used to manipulate a messages bodytext *after* the editor is called, also + see :ref:`pre_edit_translate <pre-edit-translate>` :param bodytext: text representation of mail body as displayed in the interface and as sent to the editor |