e7/e52b27d5a6eb3438233d4b9e68fa371adab003

   1 Return-Path: <david@tethera.net>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 05142431FAE\r
   6         for <notmuch@notmuchmail.org>; Tue,  4 Jun 2013 07:22:53 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -2.3\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id rAyEV7OtuLgH for <notmuch@notmuchmail.org>;\r
  16         Tue,  4 Jun 2013 07:22:45 -0700 (PDT)\r
  17 Received: from tempo.its.unb.ca (tempo.its.unb.ca [131.202.1.21])\r
  18         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id B1B2F431FAF\r
  21         for <notmuch@notmuchmail.org>; Tue,  4 Jun 2013 07:22:45 -0700 (PDT)\r
  22 Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
  23         by tempo.its.unb.ca (8.13.8/8.13.8) with ESMTP id r54EMZnS023766;\r
  24         Tue, 4 Jun 2013 11:22:36 -0300\r
  25 Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net\r
  26         ([156.34.82.78] helo=zancas.localnet)\r
  27         by tesseract.cs.unb.ca with esmtpsa\r
  28         (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80)\r
  29         (envelope-from <david@tethera.net>)\r
  30         id 1Ujs8B-0002fV-KU; Tue, 04 Jun 2013 11:22:35 -0300\r
  31 Received: from bremner by zancas.localnet with local (Exim 4.80)\r
  32         (envelope-from <david@tethera.net>)\r
  33         id 1Ujs85-0008Cw-VC; Tue, 04 Jun 2013 11:22:29 -0300\r
  34 From: David Bremner <david@tethera.net>\r
  35 To: Austin Clements <amdragon@MIT.EDU>\r
  36 Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings\r
  37 In-Reply-To: <20130604133738.GL5999@mit.edu>\r
  38 References: <1370181885-23021-1-git-send-email-david@tethera.net>\r
  39         <20130604040102.GJ5999@mit.edu> <m2ppw275hs.fsf@guru.guru-group.fi>\r
  40         <8738syrtsy.fsf@zancas.localnet> <20130604133738.GL5999@mit.edu>\r
  41 User-Agent: Notmuch/0.15.2+141~gd298af4 (http://notmuchmail.org) Emacs/24.3.1\r
  42         (x86_64-pc-linux-gnu)\r
  43 Date: Tue, 04 Jun 2013 11:22:29 -0300\r
  44 Message-ID: <87haheq7kq.fsf@zancas.localnet>\r
  45 MIME-Version: 1.0\r
  46 Content-Type: text/plain\r
  47 X-Spam_bar: -\r
  48 Cc: Tomi Ollila <tomi.ollila@iki.fi>, notmuch@notmuchmail.org\r
  49 X-BeenThere: notmuch@notmuchmail.org\r
  50 X-Mailman-Version: 2.1.13\r
  51 Precedence: list\r
  52 List-Id: "Use and development of the notmuch mail system."\r
  53         <notmuch.notmuchmail.org>\r
  54 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  55         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  56 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  57 List-Post: <mailto:notmuch@notmuchmail.org>\r
  58 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  59 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  60         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  61 X-List-Received-Date: Tue, 04 Jun 2013 14:22:53 -0000\r
  62 \r
  63 Austin Clements <amdragon@MIT.EDU> writes:\r
  64 >\r
  65 > Right.  I think we should both reference the variable and say what the\r
  66 > default behavior is (there's no reason not to do both).  But isn't\r
  67 > that what these docstrings used to do?\r
  68 \r
  69 Looking at the old docstrings in notmuch-show.el, I agree they basically\r
  70 implement Tomi's suggestion.  While I think copying default values of\r
  71 variables into docstrings creates some minor maintainability traps\r
  72 (since we then need to remember to look at all the places a variable is\r
  73 referenced if we change the default value), I'm willing to revert the\r
  74 patch if people think the tradeoff of better usability is worth it.\r
  75 \r
  76 It is unfortunate emacs doesn't provide a way to expand the current\r
  77 value of a variable in the help string, but there we are. It probably\r
  78 wouldn't be as easy to understand as hand crafted text in any case.\r
  79 \r
  80 d\r
  81 \r