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

[Tomi Ollila]

On Sat, Sep 06 2014, Mark Walters <markwalters1009 at gmail.com> wrote:

> ---
>  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."

This patch LGTM. Now that we know more I would have liked this function
would not take the START & END parameters but the function itself could
have done (window-start) (window-end) if it so desires...

... as we have discussed in IRC my current version uses (point) in place
of END (window-end) and I may drop START too (while investigating Mark's
IRC-given suggestions).

Anyway, the ship may have sailed and therefore I am inclined to give +1
to this patch...

Tomi


>    :type 'function
>    :group 'notmuch-show)
>  
> -- 
> 1.7.10.4
>
> _______________________________________________
> notmuch mailing list
> notmuch at notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch