--- /dev/null
+Return-Path: <m.walters@qmul.ac.uk>\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 4451F431FDA\r
+ for <notmuch@notmuchmail.org>; Sun, 30 Jun 2013 14:15:17 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+ tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+ NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 naruzOdDOP8y for <notmuch@notmuchmail.org>;\r
+ Sun, 30 Jun 2013 14:15:10 -0700 (PDT)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
+ (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id F2069431FAF\r
+ for <notmuch@notmuchmail.org>; Sun, 30 Jun 2013 14:15:09 -0700 (PDT)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+ by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+ (envelope-from <m.walters@qmul.ac.uk>)\r
+ id 1UtOxb-00011D-T4; Sun, 30 Jun 2013 22:15:06 +0100\r
+Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost)\r
+ by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71)\r
+ (envelope-from <m.walters@qmul.ac.uk>)\r
+ id 1UtOxb-0002DO-J6; Sun, 30 Jun 2013 22:15:03 +0100\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH v2 2/3] contrib: pick: remove hack\r
+ notmuch-pick-show-match-message-with-wait\r
+In-Reply-To: <87li5rtvbh.fsf@zancas.localnet>\r
+References: <1372582512-10777-1-git-send-email-markwalters1009@gmail.com>\r
+ <1372582512-10777-3-git-send-email-markwalters1009@gmail.com>\r
+ <87li5rtvbh.fsf@zancas.localnet>\r
+User-Agent: Notmuch/0.15.2+192~g8222af3 (http://notmuchmail.org) Emacs/23.4.1\r
+ (x86_64-pc-linux-gnu)\r
+Date: Sun, 30 Jun 2013 22:15:01 +0100\r
+Message-ID: <87hagf5mi2.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Sender-Host-Address: 93.97.24.31\r
+X-QM-SPAM-Info: Sender has good ham record. :)\r
+X-QM-Body-MD5: 38c225b8be9042716392fff3aa01a923 (of first 20000 bytes)\r
+X-SpamAssassin-Score: 0.0\r
+X-SpamAssassin-SpamBar: /\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+ determine if it is\r
+ spam. We require at least 5.0 points to mark a message as spam.\r
+ This message scored 0.0 points. Summary of the scoring: \r
+ * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+ provider * (markwalters1009[at]gmail.com)\r
+ * 0.0 AWL AWL: From: address is in the auto white-list\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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:15:17 -0000\r
+\r
+\r
+Hi\r
+\r
+Many thanks for the review!\r
+\r
+On Sun, 30 Jun 2013, David Bremner <david@tethera.net> wrote:\r
+> Mark Walters <markwalters1009@gmail.com> writes:\r
+>\r
+>> +(defvar notmuch-pick-open-target nil)\r
+>> +(make-variable-buffer-local 'notmuch-pick-open-target)\r
+>\r
+> What do people think about adding a code style suggestion/requirement\r
+> for elisp that all variables have docstrings, even if intended for\r
+> internal use? It's true the existing code doesn't really meet this\r
+> standard.\r
+\r
+I think this would be a good idea (but see below): I assume this is\r
+anything defined with a defvar?\r
+\r
+>> (defvar notmuch-pick-buffer-name nil)\r
+>> (make-variable-buffer-local 'notmuch-pick-buffer-name)\r
+>> ;; This variable is the window used for the message pane. It is set\r
+>> @@ -349,8 +351,8 @@ Does NOT change the database."\r
+>> (notmuch-pick (notmuch-search-find-thread-id)\r
+>> notmuch-search-query-string\r
+>> nil\r
+>> - (notmuch-prettify-subject (notmuch-search-find-subject)))\r
+>> - (notmuch-pick-show-match-message-with-wait))\r
+>> + (notmuch-prettify-subject (notmuch-search-find-subject))\r
+>> + t))\r
+>\r
+> I think my previous complaint can be reformulated as (essentially) both\r
+> notmuch-pick and notmuch-pick-open-target could use (better) docstrings.\r
+\r
+I will send a patch to add a docstring to the main notmuch-pick function\r
+as a reply to this message. The exact style was unclear (we seem to do\r
+different things in different places).\r
+\r
+I am not sure what the best way to document the variable is: there are\r
+several variables that are essentially buffer local versions of the\r
+arguments passed to notmuch-pick. Should these duplicate the\r
+documentation? Exactly the same situation occurs with notmuch-show in\r
+notmuch-show.el and notmuch-search in notmuch.el and in both those cases\r
+the functions are well documented but the variables are not documented.\r
+\r
+Any suggestions?\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r
+\r
+\r
+> As you say, the hack removed is quite horrible, so I'd be willing to\r
+> merge the patches anyway. OTOH, more documentation might make it so that\r
+> more than one person can understand the notmuch-pick code.\r
+>\r
+> d\r
projects / notmuch-archives.git / commitdiff