From: Mark Walters Date: Mon, 1 Jul 2013 07:53:59 +0000 (+0100) Subject: [PATCH 1/5] contrib: pick: add a docstring for the main notmuch-pick function X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=065f0b3c82d42e4c71c88fa3538023964b301573;p=notmuch-archives.git [PATCH 1/5] contrib: pick: add a docstring for the main notmuch-pick function --- diff --git a/2f/e96ea7e6c69205b89839fd6670f4627a4c1994 b/2f/e96ea7e6c69205b89839fd6670f4627a4c1994 new file mode 100644 index 000000000..18c29494e --- /dev/null +++ b/2f/e96ea7e6c69205b89839fd6670f4627a4c1994 @@ -0,0 +1,96 @@ +Return-Path: +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 4D103429E30 + for ; Mon, 1 Jul 2013 00:54:17 -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 cfqV2699Xqn7 for ; + Mon, 1 Jul 2013 00:54:10 -0700 (PDT) +Received: from mail-wg0-f53.google.com (mail-wg0-f53.google.com + [74.125.82.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client + certificate requested) by olra.theworths.org (Postfix) with ESMTPS id + 8E0ED431FDA for ; Mon, 1 Jul 2013 00:54:10 -0700 + (PDT) +Received: by mail-wg0-f53.google.com with SMTP id y10so3514111wgg.32 + for ; Mon, 01 Jul 2013 00:54:09 -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:in-reply-to:references; + bh=G7YQtNXvDlKL9qtD58Q5F5ZDOBeLtVitJ+jWymq6/jg=; + b=QrQ9Fz2yhD1ntKyx+RJMpNmCIlhwTUBFlwpVKIyhBWiPVDnMcqRFgntRT3KZm9VflD + k61wQOW+Glzy7PwK7StRY0F+XG1m7KEigrX6iSzcPOtg2ospVm1PHXkdRVyPo46e4xSM + yy7UJkvkacsvYZkG0OKJxK3HZqqJKFtIeLdYEznaH2oWbuXLazgxk5GmcIrxh3dQTIOY + yfCmwPwQA0DRUMD0jfU9QFtfJtIPojpnDw7vMGEPYcjoU2CQSX9yEw5c66EG7EKaJ1lX + IkfJXQBqzcD+8X2cmUYvYvm7BG3iRreH7cLxDhhVbfPXFB8kcy/RfIJlEpO9FnFEr7M6 + RoJQ== +X-Received: by 10.194.249.129 with SMTP id yu1mr19452865wjc.10.1372665249322; + Mon, 01 Jul 2013 00:54:09 -0700 (PDT) +Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31]) + by mx.google.com with ESMTPSA id d8sm14553067wiz.0.2013.07.01.00.54.08 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Mon, 01 Jul 2013 00:54:08 -0700 (PDT) +From: Mark Walters +To: notmuch@notmuchmail.org +Subject: [PATCH 1/5] contrib: pick: add a docstring for the main notmuch-pick + function +Date: Mon, 1 Jul 2013 08:53:59 +0100 +Message-Id: <1372665243-7675-2-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 1.7.9.1 +In-Reply-To: <1372665243-7675-1-git-send-email-markwalters1009@gmail.com> +References: <1372665243-7675-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." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Mon, 01 Jul 2013 07:54:17 -0000 + +--- + contrib/notmuch-pick/notmuch-pick.el | 14 +++++++++++++- + 1 files changed, 13 insertions(+), 1 deletions(-) + +diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el +index 11b5058..287c3e5 100644 +--- a/contrib/notmuch-pick/notmuch-pick.el ++++ b/contrib/notmuch-pick/notmuch-pick.el +@@ -817,7 +817,19 @@ Complete list of currently available key bindings: + + + (defun notmuch-pick (&optional query query-context target buffer-name open-target) +- "Run notmuch pick with the given `query' and display the results" ++ "Run notmuch pick with the given `query' and display the results. ++ ++The arguments are: ++ QUERY: the main query. This can be any query but in many cases will be ++ a single thread. If nil this is read interactively from the minibuffer. ++ QUERY-CONTEXT: is an additional term for the query. The query used ++ is QUERY and QUERY-CONTEXT unless that does not match any messages ++ in which case we fall back to just QUERY. ++ TARGET: A message ID (with the id: prefix) that will be made ++ current if it appears in the pick results. ++ BUFFER-NAME: the name of the buffer to show the pick tree. If ++ it is nil \"*notmuch-pick\" followed by QUERY is used. ++ OPEN-TARGET: If TRUE open the target message in the message pane." + (interactive "sNotmuch pick: ") + (if (null query) + (setq query (notmuch-read-query "Notmuch pick: "))) +-- +1.7.9.1 +