[PATCH 2/5] contrib: pick: add docstrings to all defvars

diff --git a/8b/9032379c1c519f1d0b459957ac25991055f19a b/8b/9032379c1c519f1d0b459957ac25991055f19a
new file mode 100644 (file)
index 0000000..bb58614
--- /dev/null
+++ b/8b/9032379c1c519f1d0b459957ac25991055f19a
@@ -0,0 +1,140 @@
+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 6B69F429E3D\r
+       for <notmuch@notmuchmail.org>; Mon,  1 Jul 2013 00:54:22 -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 nasxeTWVJMa3 for <notmuch@notmuchmail.org>;\r
+       Mon,  1 Jul 2013 00:54:17 -0700 (PDT)\r
+Received: from mail-wi0-f171.google.com (mail-wi0-f171.google.com\r
+       [209.85.212.171]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id B0413429E25\r
+       for <notmuch@notmuchmail.org>; Mon,  1 Jul 2013 00:54:12 -0700 (PDT)\r
+Received: by mail-wi0-f171.google.com with SMTP id hj3so2739645wib.16\r
+       for <notmuch@notmuchmail.org>; Mon, 01 Jul 2013 00:54:11 -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=e9RqSZcBg2aH5OcYioasIwwsthcwWn4EGHB81gaGlpY=;\r
+       b=pubqcFwwCUhHAS5F0bCPr6xpdD5Bt2Gc1YI35I27O+mz4BHS/p7EKvrfNO5xY5qaIf\r
+       ovAERHV7P6Q5oXsgAfSDDPkb12JCocQhMu2gKqJO+n1hC4WbYzNVabCCC3D4iw4oRKXU\r
+       L//jzfEF44dwfkRTBF5v8qqAF6V6kS2zVlWlkLzZ9w6xQ22HjGvaQpQ6UCcfDJgTJfjI\r
+       pTShM51nxn+CsX83znC+UmYPw0n3lOMgj4npLGdBN6NgGU46kZZ8d1jxZlHIoaekbQpP\r
+       YyEERG46+zBDBPQif70lhAti2FlWTFyrP4wh6xCdp08niRlkxzcuEQEOM0Mn+Z+FeEz5\r
+       MHpg==\r
+X-Received: by 10.180.85.8 with SMTP id d8mr11246369wiz.13.1372665251636;\r
+       Mon, 01 Jul 2013 00:54:11 -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 b20sm14513475wiw.4.2013.07.01.00.54.10\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Mon, 01 Jul 2013 00:54:11 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 2/5] contrib: pick: add docstrings to all defvars\r
+Date: Mon,  1 Jul 2013 08:54:00 +0100\r
+Message-Id: <1372665243-7675-3-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+In-Reply-To: <1372665243-7675-1-git-send-email-markwalters1009@gmail.com>\r
+References: <1372665243-7675-1-git-send-email-markwalters1009@gmail.com>\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: Mon, 01 Jul 2013 07:54:22 -0000\r
+\r
+---\r
+ contrib/notmuch-pick/notmuch-pick.el |   45 ++++++++++++++++++++++-----------\r
+ 1 files changed, 30 insertions(+), 15 deletions(-)\r
+\r
+diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el\r
+index 287c3e5..cce3cb7 100644\r
+--- a/contrib/notmuch-pick/notmuch-pick.el\r
++++ b/contrib/notmuch-pick/notmuch-pick.el\r
+@@ -146,35 +146,50 @@\r
+   :group 'notmuch-pick\r
+   :group 'notmuch-faces)\r
+ \r
+-(defvar notmuch-pick-previous-subject "")\r
++(defvar notmuch-pick-previous-subject\r
++  "The subject of the most recent result shown during the async display")\r
+ (make-variable-buffer-local 'notmuch-pick-previous-subject)\r
+ \r
+-;; The basic query i.e. the key part of the search request.\r
+-(defvar notmuch-pick-basic-query nil)\r
++(defvar notmuch-pick-basic-query nil\r
++  "A buffer local copy of argument query to the function notmuch-pick")\r
+ (make-variable-buffer-local 'notmuch-pick-basic-query)\r
+-;; The context of the search: i.e., useful but can be dropped.\r
+-(defvar notmuch-pick-query-context nil)\r
++\r
++(defvar notmuch-pick-query-context nil\r
++  "A buffer local copy of argument query-context to the function notmuch-pick")\r
+ (make-variable-buffer-local 'notmuch-pick-query-context)\r
+-(defvar notmuch-pick-target-msg nil)\r
++\r
++(defvar notmuch-pick-target-msg nil\r
++  "A buffer local copy of argument target to the function notmuch-pick")\r
+ (make-variable-buffer-local 'notmuch-pick-target-msg)\r
+-(defvar notmuch-pick-open-target nil)\r
++\r
++(defvar notmuch-pick-open-target nil\r
++  "A buffer local copy of argument open-target to the function notmuch-pick")\r
+ (make-variable-buffer-local 'notmuch-pick-open-target)\r
+-(defvar notmuch-pick-buffer-name nil)\r
++\r
++(defvar notmuch-pick-buffer-name nil\r
++  "A buffer local copy of argument buffer-name to the function notmuch-pick")\r
+ (make-variable-buffer-local 'notmuch-pick-buffer-name)\r
+-;; This variable is the window used for the message pane. It is set\r
+-;; in both the parent pick buffer and the child show buffer. It is\r
+-;; used to try and close the message pane when quitting pick or the\r
+-;; child show buffer.\r
+-(defvar notmuch-pick-message-window nil)\r
++\r
++(defvar notmuch-pick-message-window nil\r
++  "The window of the message pane.\r
++\r
++It is set in both the pick buffer and the child show buffer. It\r
++is used to try and close the message pane when quitting pick or\r
++the child show buffer.")\r
+ (make-variable-buffer-local 'notmuch-pick-message-window)\r
+ (put 'notmuch-pick-message-window 'permanent-local t)\r
+-(defvar notmuch-pick-message-buffer nil)\r
++\r
++(defvar notmuch-pick-message-buffer nil\r
++  "The buffer name of the show buffer in the message pane.\r
++\r
++This is used to try and make sure we don't close the message pane\r
++if the user has loaded a different buffer in that window.")\r
+ (make-variable-buffer-local 'notmuch-pick-message-buffer-name)\r
+ (put 'notmuch-pick-message-buffer-name 'permanent-local t)\r
++\r
+ (defvar notmuch-pick-process-state nil\r
+   "Parsing state of the search process filter.")\r
+ \r
+-\r
+ (defvar notmuch-pick-mode-map\r
+   (let ((map (make-sparse-keymap)))\r
+     (define-key map [mouse-1] 'notmuch-pick-show-message)\r
+-- \r
+1.7.9.1\r
+\r