Re: [PATCH] emacs: remove hardcoded defaults values from docstrings

diff --git a/e7/e52b27d5a6eb3438233d4b9e68fa371adab003 b/e7/e52b27d5a6eb3438233d4b9e68fa371adab003
new file mode 100644 (file)
index 0000000..4ed19ee
--- /dev/null
+++ b/e7/e52b27d5a6eb3438233d4b9e68fa371adab003
@@ -0,0 +1,81 @@
+Return-Path: <david@tethera.net>\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 05142431FAE\r
+       for <notmuch@notmuchmail.org>; Tue,  4 Jun 2013 07:22:53 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[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 rAyEV7OtuLgH for <notmuch@notmuchmail.org>;\r
+       Tue,  4 Jun 2013 07:22:45 -0700 (PDT)\r
+Received: from tempo.its.unb.ca (tempo.its.unb.ca [131.202.1.21])\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 B1B2F431FAF\r
+       for <notmuch@notmuchmail.org>; Tue,  4 Jun 2013 07:22:45 -0700 (PDT)\r
+Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
+       by tempo.its.unb.ca (8.13.8/8.13.8) with ESMTP id r54EMZnS023766;\r
+       Tue, 4 Jun 2013 11:22:36 -0300\r
+Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net\r
+       ([156.34.82.78] helo=zancas.localnet)\r
+       by tesseract.cs.unb.ca with esmtpsa\r
+       (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80)\r
+       (envelope-from <david@tethera.net>)\r
+       id 1Ujs8B-0002fV-KU; Tue, 04 Jun 2013 11:22:35 -0300\r
+Received: from bremner by zancas.localnet with local (Exim 4.80)\r
+       (envelope-from <david@tethera.net>)\r
+       id 1Ujs85-0008Cw-VC; Tue, 04 Jun 2013 11:22:29 -0300\r
+From: David Bremner <david@tethera.net>\r
+To: Austin Clements <amdragon@MIT.EDU>\r
+Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings\r
+In-Reply-To: <20130604133738.GL5999@mit.edu>\r
+References: <1370181885-23021-1-git-send-email-david@tethera.net>\r
+       <20130604040102.GJ5999@mit.edu> <m2ppw275hs.fsf@guru.guru-group.fi>\r
+       <8738syrtsy.fsf@zancas.localnet> <20130604133738.GL5999@mit.edu>\r
+User-Agent: Notmuch/0.15.2+141~gd298af4 (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Tue, 04 Jun 2013 11:22:29 -0300\r
+Message-ID: <87haheq7kq.fsf@zancas.localnet>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+X-Spam_bar: -\r
+Cc: Tomi Ollila <tomi.ollila@iki.fi>, notmuch@notmuchmail.org\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: Tue, 04 Jun 2013 14:22:53 -0000\r
+\r
+Austin Clements <amdragon@MIT.EDU> writes:\r
+>\r
+> Right.  I think we should both reference the variable and say what the\r
+> default behavior is (there's no reason not to do both).  But isn't\r
+> that what these docstrings used to do?\r
+\r
+Looking at the old docstrings in notmuch-show.el, I agree they basically\r
+implement Tomi's suggestion.  While I think copying default values of\r
+variables into docstrings creates some minor maintainability traps\r
+(since we then need to remember to look at all the places a variable is\r
+referenced if we change the default value), I'm willing to revert the\r
+patch if people think the tradeoff of better usability is worth it.\r
+\r
+It is unfortunate emacs doesn't provide a way to expand the current\r
+value of a variable in the help string, but there we are. It probably\r
+wouldn't be as easy to understand as hand crafted text in any case.\r
+\r
+d\r
+\r