diff options
| author | Mark Walters <markwalters1009@gmail.com> | 2014-09-06 17:22:10 +0100 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2014-11-09 16:08:58 +0100 |
| commit | 78a1575aa41de2b593ca47ff1ca72673f26088fa (patch) | |
| tree | eecb1abf96fbfc72a6f138c0fc8c9dd10c2298ad | |
| parent | 0d8251dbe236975e69b07de2aeb9b60df44d6929 (diff) | |
emacs: show: document the mark unread defcustom function
| -rw-r--r-- | emacs/notmuch-show.el | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el index 6e03f1e7..4035fe88 100644 --- a/emacs/notmuch-show.el +++ b/emacs/notmuch-show.el @@ -224,7 +224,13 @@ For example, if you wanted to remove an \"unread\" tag and add a :group 'notmuch-show) (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message - "Function to control which messages are marked read." + "Function to control which messages are marked read. + +The function should take two arguments START and END which will +be the start and end of the visible portion of the buffer and +should mark the appropriate messages read by applying +`notmuch-show-mark-read'. This function will be called after +every user interaction with notmuch." :type 'function :group 'notmuch-show) |