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