[Patch v2 1/2] emacs: show: document the mark unread defcustom function

Subject: [Patch v2 1/2] emacs: show: document the mark unread defcustom function

Date: Sat, 6 Sep 2014 17:22:10 +0100

To: notmuch@notmuchmail.org

Cc:

From: Mark Walters

---
 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 7549fbb..5695d95 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)
 
-- 
1.7.10.4

Thread: