From: Mark Walters <markwalters1009@gmail.com>
Date: Sat, 6 Sep 2014 16:22:10 +0000 (+0100)
Subject: emacs: show: document the mark unread defcustom function
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=78a1575aa41de2b593ca47ff1ca72673f26088fa;p=notmuch.git

emacs: show: document the mark unread defcustom function
---

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)