diff options
| author | Lucas Hoffmann <l-m-h@web.de> | 2017-01-26 21:28:35 +0100 |
|---|---|---|
| committer | Lucas Hoffmann <l-m-h@web.de> | 2017-01-26 21:28:35 +0100 |
| commit | 71cd8d50ccc8e8ce800e0db2efa4db285547b152 (patch) | |
| tree | 95dc4fba1e76a1f92c7cf3344228d3031e983967 /docs | |
| parent | b22e9d7ac7af361ea5c7e40eb9d20e2d18e58210 (diff) | |
Remove explicit mention of "body" in {pre,post}_edit_translate hook's docs
This is done to give more emphasis to the fact that there might be header
lines at the top of the string.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/configuration/hooks.rst | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst index bf87a42d..6e7162e8 100644 --- a/docs/source/configuration/hooks.rst +++ b/docs/source/configuration/hooks.rst @@ -70,26 +70,26 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: .. _pre-edit-translate: -.. py:function:: pre_edit_translate(bodytext[, ui= None, dbm=None]) +.. py:function:: pre_edit_translate(text[, ui= None, dbm=None]) - Used to manipulate a messages bodytext *before* the editor is called. The - bodytext might also contain some header lines, depending on the settings + Used to manipulate a message's text *before* the editor is called. The + text 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 - :type bodytext: str + :param text: text representation of mail as displayed in the interface and + as sent to the editor + :type text: str :rtype: str -.. py:function:: post_edit_translate(bodytext[, ui= None, dbm=None]) +.. py:function:: post_edit_translate(text[, ui= None, dbm=None]) - used to manipulate a messages bodytext *after* the editor is called, also - see :ref:`pre_edit_translate <pre-edit-translate>` + used to manipulate a message's text *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 - :type bodytext: str + :param text: text representation of mail as displayed in the interface and + as sent to the editor + :type text: str :rtype: str .. py:function:: text_quote(message) @@ -104,7 +104,7 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: represents given timestamp as string - :param bodytext: timestamp to represent + :param timestamp: timestamp to represent :type timestamp: `datetime` :rtype: str |