[PATCH] contrib: pick: add a docstring for the main notmuch-pick function

diff --git a/48/2aa01b35c90af2ebd91843338bdf8e9f9ed9fc b/48/2aa01b35c90af2ebd91843338bdf8e9f9ed9fc
new file mode 100644 (file)
index 0000000..7fbb4a3
--- /dev/null
+++ b/48/2aa01b35c90af2ebd91843338bdf8e9f9ed9fc
@@ -0,0 +1,96 @@
+Return-Path: <markwalters1009@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 91DE8431FDE\r
+       for <notmuch@notmuchmail.org>; Sun, 30 Jun 2013 14:18:56 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.201\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
+       RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id A1yI2Z6FxKs6 for <notmuch@notmuchmail.org>;\r
+       Sun, 30 Jun 2013 14:18:51 -0700 (PDT)\r
+Received: from mail-wg0-f49.google.com (mail-wg0-f49.google.com\r
+ [74.125.82.49])       (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
+ certificate requested)        by olra.theworths.org (Postfix) with ESMTPS id\r
+ E96C5431FDB   for <notmuch@notmuchmail.org>; Sun, 30 Jun 2013 14:18:50 -0700\r
+ (PDT)\r
+Received: by mail-wg0-f49.google.com with SMTP id a12so3115356wgh.28\r
+       for <notmuch@notmuchmail.org>; Sun, 30 Jun 2013 14:18:49 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
+       bh=k+VyIsBHjOe2aYX7/ZFQdLrMfr/cDTuHjU5JOTZnZbM=;\r
+       b=gunmUpJ4ciX0RZHohesHYvOWcQvJUYqlSwdRQ9MZ+Pu43wemhnHQfNyrGs67nFAONz\r
+       9lpmqQVXI+iudVlSwsrpAfuSORbr1fUedsd4bpsdBIqvKVB2RXlDiK1NvOP0daHHkt0i\r
+       dSiQEOgoY8MSJ9g6SHWqfUTfqQedXFISz5tThcju73v3gPxJX1mbrP5wy7bkePEnIOEQ\r
+       S+yNXfwNa8VAvcDp60kxfoMBCyvgLlLEMUhVx0FXPTaA4aNmrV8BSPk5hKwV3pWUPlSj\r
+       5jPkFdZogJR5FIyNpmGnTsPQ5r3phOdgCSjw/NAMf4LZt2sTCyJ779UqQHAqi25zKkgg\r
+       EshQ==\r
+X-Received: by 10.194.48.49 with SMTP id i17mr18434574wjn.55.1372627129844;\r
+       Sun, 30 Jun 2013 14:18:49 -0700 (PDT)\r
+Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31])\r
+       by mx.google.com with ESMTPSA id d8sm12385805wiz.0.2013.06.30.14.18.48\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sun, 30 Jun 2013 14:18:49 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] contrib: pick: add a docstring for the main notmuch-pick\r
+       function\r
+Date: Sun, 30 Jun 2013 22:18:37 +0100\r
+Message-Id: <1372627117-31188-1-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+In-Reply-To: <87hagf5mi2.fsf@qmul.ac.uk>\r
+References: <87hagf5mi2.fsf@qmul.ac.uk>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 30 Jun 2013 21:18:56 -0000\r
+\r
+---\r
+ contrib/notmuch-pick/notmuch-pick.el |   14 +++++++++++++-\r
+ 1 files changed, 13 insertions(+), 1 deletions(-)\r
+\r
+diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el\r
+index 26966e6..a42491e 100644\r
+--- a/contrib/notmuch-pick/notmuch-pick.el\r
++++ b/contrib/notmuch-pick/notmuch-pick.el\r
+@@ -818,7 +818,19 @@ Complete list of currently available key bindings:\r
+ \r
+ \r
+ (defun notmuch-pick (&optional query query-context target buffer-name open-target)\r
+-  "Run notmuch pick with the given `query' and display the results"\r
++  "Run notmuch pick with the given `query' and display the results.\r
++\r
++The arguments are:\r
++  QUERY: the main query. This can be any query but in many cases will be\r
++      a single thread. If nil this is read interactively from the minibuffer.\r
++  QUERY-CONTEXT: is an additional term for the query. The query used\r
++      is QUERY and QUERY-CONTEXT unless that does not match any messages\r
++      in which case we fall back to just QUERY.\r
++  TARGET: A message ID (with the id: prefix) that will be made\r
++      current if it appears in the pick results.\r
++  BUFFER-NAME: the name of the buffer to show the pick tree. If\r
++      it is nil \"*notmuch-pick\" followed by QUERY is used.\r
++  OPEN-TARGET: If TRUE open the target message in the message pane."\r
+   (interactive "sNotmuch pick: ")\r
+   (if (null query)\r
+       (setq query (notmuch-read-query "Notmuch pick: ")))\r
+-- \r
+1.7.9.1\r
+\r