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 E112F429E30
	for <notmuch@notmuchmail.org>; Mon,  1 Jul 2013 00:54:16 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Spam-Flag: NO
X-Spam-Score: 2.7
X-Spam-Level: **
X-Spam-Status: No, score=2.7 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,
	FREEMAIL_REPLY=2.499, 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 Ma06FMTzCAGx for <notmuch@notmuchmail.org>;
	Mon,  1 Jul 2013 00:54:12 -0700 (PDT)
Received: from mail-wi0-f171.google.com (mail-wi0-f171.google.com
	[209.85.212.171]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
	(No client certificate requested)
	by olra.theworths.org (Postfix) with ESMTPS id 56702431E82
	for <notmuch@notmuchmail.org>; Mon,  1 Jul 2013 00:54:12 -0700 (PDT)
Received: by mail-wi0-f171.google.com with SMTP id hj3so2742529wib.4
	for <notmuch@notmuchmail.org>; Mon, 01 Jul 2013 00:54:08 -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:x-mailer;
	bh=y8uIFi3OB7r6aEQzVElou7TSq4y83kAmh9ONPMxo/U0=;
	b=fjhWt4mOwcQOt3koVyKooefMVFyA9+2j1nJEmJoGb4kjCdB4L8Qixl9wYG2PTfVSyQ
	3p3b8xkOzpn7D6NWC35g31zRNXmsQ83J85PBRS+n1+owA9V9aqVhohTOhZz5wih4l5gp
	34IQchnY+iPZgcwypX+uvG+Av2etGVUyOdsbxpfbwHmQ84yXhDzf5D86R+sGqWLA8xL9
	MhFKXEK7wGGwp0kOKV2WOTEiglcITKCSOL38asDteQYQhwfGYyTN0rMeT4CLWTxTxFvQ
	lKaBB8oOQYjTsr2aqIO8KpNwobxw4O+Rimzj5g6zEOpJChNyuqBu6WAAwVWYMe1yLx/s
	T4EA==
X-Received: by 10.194.24.40 with SMTP id r8mr18868041wjf.7.1372665247589;
	Mon, 01 Jul 2013 00:54:07 -0700 (PDT)
Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31])
	by mx.google.com with ESMTPSA id p1sm14445015wix.9.2013.07.01.00.54.06
	for <multiple recipients>
	(version=TLSv1.2 cipher=RC4-SHA bits=128/128);
	Mon, 01 Jul 2013 00:54:07 -0700 (PDT)
From: Mark Walters <markwalters1009@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH 0/5] Document notmuch-pick and some bugfixes
Date: Mon,  1 Jul 2013 08:53:58 +0100
Message-Id: <1372665243-7675-1-git-send-email-markwalters1009@gmail.com>
X-Mailer: git-send-email 1.7.9.1
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: Mon, 01 Jul 2013 07:54:17 -0000

This adds some documentation to all the defvars in notmuch-pick and to
the notmuch-pick function itself (as suggested by David in
id:87li5rtvbh.fsf@zancas.localnet. This series replaces
id:1372627117-31188-1-git-send-email-markwalters1009@gmail.com but
does still need to be applied on top of the main series there (because
it documents the pick function as it is after that change).

When documenting the defvars I found some trivial bugs: the most
serious being the wrong variable name being made buffer-local. This is
less serious than it could be as this variable was just used to try
and avoid closing the message pane if the user had loaded a different
buffer into it.

The other "bugs" were defvars for variables which are no longer
used. In one case a moderate amount of effort was made passing this
unused variable around so the patch to remove it is not tiny and thus
its removal is delayed until a followup series.

Finally, when looking at which functions did not have docstrings (some
still need to be added after this series) I found an unused historical
function so remove that too.

Best wishes

Mark



Mark Walters (5):
  contrib: pick: add a docstring for the main notmuch-pick function
  contrib: pick: add docstrings to all defvars
  contrib: pick: bugfix: make the right variable buffer-local
  contrib: pick: remove unused variable
  contrib: pick: remove unused function

 contrib/notmuch-pick/notmuch-pick.el |   71 ++++++++++++++++++++-------------
 1 files changed, 43 insertions(+), 28 deletions(-)

-- 
1.7.9.1