From 6e0df710a8030984f38c43bf5053704a3142df4b Mon Sep 17 00:00:00 2001 From: Mark Walters Date: Sun, 30 Jun 2013 22:18:37 +0100 Subject: [PATCH] [PATCH] contrib: pick: add a docstring for the main notmuch-pick function --- 48/2aa01b35c90af2ebd91843338bdf8e9f9ed9fc | 96 +++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 48/2aa01b35c90af2ebd91843338bdf8e9f9ed9fc diff --git a/48/2aa01b35c90af2ebd91843338bdf8e9f9ed9fc b/48/2aa01b35c90af2ebd91843338bdf8e9f9ed9fc new file mode 100644 index 000000000..7fbb4a31a --- /dev/null +++ b/48/2aa01b35c90af2ebd91843338bdf8e9f9ed9fc @@ -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 91DE8431FDE + for ; Sun, 30 Jun 2013 14:18:56 -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 A1yI2Z6FxKs6 for ; + Sun, 30 Jun 2013 14:18:51 -0700 (PDT) +Received: from mail-wg0-f49.google.com (mail-wg0-f49.google.com + [74.125.82.49]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client + certificate requested) by olra.theworths.org (Postfix) with ESMTPS id + E96C5431FDB for ; Sun, 30 Jun 2013 14:18:50 -0700 + (PDT) +Received: by mail-wg0-f49.google.com with SMTP id a12so3115356wgh.28 + for ; Sun, 30 Jun 2013 14:18:49 -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=k+VyIsBHjOe2aYX7/ZFQdLrMfr/cDTuHjU5JOTZnZbM=; + b=gunmUpJ4ciX0RZHohesHYvOWcQvJUYqlSwdRQ9MZ+Pu43wemhnHQfNyrGs67nFAONz + 9lpmqQVXI+iudVlSwsrpAfuSORbr1fUedsd4bpsdBIqvKVB2RXlDiK1NvOP0daHHkt0i + dSiQEOgoY8MSJ9g6SHWqfUTfqQedXFISz5tThcju73v3gPxJX1mbrP5wy7bkePEnIOEQ + S+yNXfwNa8VAvcDp60kxfoMBCyvgLlLEMUhVx0FXPTaA4aNmrV8BSPk5hKwV3pWUPlSj + 5jPkFdZogJR5FIyNpmGnTsPQ5r3phOdgCSjw/NAMf4LZt2sTCyJ779UqQHAqi25zKkgg + EshQ== +X-Received: by 10.194.48.49 with SMTP id i17mr18434574wjn.55.1372627129844; + Sun, 30 Jun 2013 14:18:49 -0700 (PDT) +Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31]) + by mx.google.com with ESMTPSA id d8sm12385805wiz.0.2013.06.30.14.18.48 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Sun, 30 Jun 2013 14:18:49 -0700 (PDT) +From: Mark Walters +To: notmuch@notmuchmail.org +Subject: [PATCH] contrib: pick: add a docstring for the main notmuch-pick + function +Date: Sun, 30 Jun 2013 22:18:37 +0100 +Message-Id: <1372627117-31188-1-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 1.7.9.1 +In-Reply-To: <87hagf5mi2.fsf@qmul.ac.uk> +References: <87hagf5mi2.fsf@qmul.ac.uk> +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: Sun, 30 Jun 2013 21:18:56 -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 26966e6..a42491e 100644 +--- a/contrib/notmuch-pick/notmuch-pick.el ++++ b/contrib/notmuch-pick/notmuch-pick.el +@@ -818,7 +818,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 + -- 2.26.2