From 78a1575aa41de2b593ca47ff1ca72673f26088fa Mon Sep 17 00:00:00 2001 From: Mark Walters Date: Sat, 6 Sep 2014 17:22:10 +0100 Subject: [PATCH] emacs: show: document the mark unread defcustom function --- emacs/notmuch-show.el | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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) -- 2.43.0