Return-Path: <markwalters1009@gmail.com>
X-Original-To: notmuch@notmuchmail.org
Delivered-To: notmuch@notmuchmail.org
Received: from localhost (localhost [127.0.0.1])
	by olra.theworths.org (Postfix) with ESMTP id 972E7431FAE
	for <notmuch@notmuchmail.org>; Sat,  6 Sep 2014 09:22:27 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Spam-Flag: NO
X-Spam-Score: 0.201
X-Spam-Level: 
X-Spam-Status: No, score=0.201 tagged_above=-999 required=5
	tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,
	FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,
	RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled
Received: from olra.theworths.org ([127.0.0.1])
	by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
	with ESMTP id Gp1Er5nbP01u for <notmuch@notmuchmail.org>;
	Sat,  6 Sep 2014 09:22:22 -0700 (PDT)
Received: from mail-we0-f182.google.com (mail-we0-f182.google.com
	[74.125.82.182]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
	(No client certificate requested)
	by olra.theworths.org (Postfix) with ESMTPS id 00489431FBC
	for <notmuch@notmuchmail.org>; Sat,  6 Sep 2014 09:22:17 -0700 (PDT)
Received: by mail-we0-f182.google.com with SMTP id w62so13185879wes.27
	for <notmuch@notmuchmail.org>; Sat, 06 Sep 2014 09:22:16 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;
	h=from:to:cc:subject:date:message-id:in-reply-to:references;
	bh=gMftLOtaKKBMEAhZknEctsjULfY46gOp1A4HvJhSWss=;
	b=sopk8/AG0alzJoDjuBuL2kCKpztm8Y54fdpJ+tMHhLt6kEVmQf49qPXS/3ETpZv/1c
	nINNRN+W86RLrUWENjzPZfbHi5Gwm22xVszSiH9tY0VQ89SbFyHTkb0YySAMljgdvN3y
	7e1krjquXe1p0Epx7uFTrLP+qppagsNAfR73iG43+JyQohUToTYZZ2Km0B8K+ogS6jvf
	3GT/l1tYBmdMHzOlYzIq6+cUCNpTnHQMgWDarsyGkwfseOHTpyeFrWJkeQxm0fogBOS/
	l2k9ukBNy8b3i0qEvTmbWsYfxX1pc1MxAY6Hzcg7mxUfPqfqdAAYxnpRkvfWqn/Uvyfo
	kDeg==
X-Received: by 10.180.37.16 with SMTP id u16mr11106147wij.72.1410020536834;
	Sat, 06 Sep 2014 09:22:16 -0700 (PDT)
Received: from localhost (5751dfa2.skybroadband.com. [87.81.223.162])
	by mx.google.com with ESMTPSA id pc6sm4967326wjb.43.2014.09.06.09.22.15
	for <multiple recipients>
	(version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);
	Sat, 06 Sep 2014 09:22:16 -0700 (PDT)
From: Mark Walters <markwalters1009@gmail.com>
To: notmuch@notmuchmail.org
Subject: [Patch v2 1/2] emacs: show: document the mark unread defcustom
	function
Date: Sat,  6 Sep 2014 17:22:10 +0100
Message-Id: <1410020531-24419-2-git-send-email-markwalters1009@gmail.com>
X-Mailer: git-send-email 1.7.10.4
In-Reply-To: <1410020531-24419-1-git-send-email-markwalters1009@gmail.com>
References: <1410020531-24419-1-git-send-email-markwalters1009@gmail.com>
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: "Use and development of the notmuch mail system."
	<notmuch.notmuchmail.org>
List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Sat, 06 Sep 2014 16:22:27 -0000

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