Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
authorAustin Clements <amdragon@MIT.EDU>
Tue, 4 Jun 2013 13:37:38 +0000 (09:37 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:55:25 +0000 (09:55 -0800)
ff/9adf05698775e5754c3165df13bc38780aadd9 [new file with mode: 0644]

diff --git a/ff/9adf05698775e5754c3165df13bc38780aadd9 b/ff/9adf05698775e5754c3165df13bc38780aadd9
new file mode 100644 (file)
index 0000000..d057f40
--- /dev/null
@@ -0,0 +1,106 @@
+Return-Path: <amdragon@mit.edu>\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 C2CD0431FB6\r
+       for <notmuch@notmuchmail.org>; Tue,  4 Jun 2013 06:37:54 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[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 RnpqIao62csw for <notmuch@notmuchmail.org>;\r
+       Tue,  4 Jun 2013 06:37:45 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-5.mit.edu (dmz-mailsec-scanner-5.mit.edu\r
+       [18.7.68.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id 0B6BC431FAE\r
+       for <notmuch@notmuchmail.org>; Tue,  4 Jun 2013 06:37:44 -0700 (PDT)\r
+X-AuditID: 12074422-b7f5b6d00000095d-2f-51adeda868ca\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+       by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 9C.70.02397.8ADEDA15; Tue,  4 Jun 2013 09:37:44 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id r54DbgVw020085; \r
+       Tue, 4 Jun 2013 09:37:43 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r54DbeFZ019617\r
+       (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT);\r
+       Tue, 4 Jun 2013 09:37:41 -0400\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.80)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1UjrQh-0007yV-Hf; Tue, 04 Jun 2013 09:37:39 -0400\r
+Date: Tue, 4 Jun 2013 09:37:38 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: David Bremner <david@tethera.net>\r
+Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings\r
+Message-ID: <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>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <8738syrtsy.fsf@zancas.localnet>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFprJKsWRmVeSWpSXmKPExsUixCmqrLvi7dpAg6uPVC1utHYzWly/OZPZ\r
+       4s3KeawOzB6Hvy5k8Xi26hazx5ZD75kDmKO4bFJSczLLUov07RK4Mn4vnMZW8I+r4u164wbG\r
+       xxxdjJwcEgImEts+f2WEsMUkLtxbz9bFyMUhJLCPUWJW8y0oZwOjxKuG++wQzikmiYVtS6Ay\r
+       Sxgl1i1ZywLSzyKgItHR/p4ZxGYT0JDYtn852FwRAVWJq9smAzVwcDAL2EpMvRIDEhYW8JG4\r
+       v/EaG4jNK6Atse/7DFaImWsYJQ5fbWGBSAhKnJz5BMxmFtCSuPHvJRPEHGmJ5f/AXuAU0JU4\r
+       t/Qo2FpRoBOmnNzGNoFRaBaS7llIumchdC9gZF7FKJuSW6Wbm5iZU5yarFucnJiXl1qka6qX\r
+       m1mil5pSuokRFOrsLko7GH8eVDrEKMDBqMTDq7hlTaAQa2JZcWXuIUZJDiYlUd7nt9YGCvEl\r
+       5adUZiQWZ8QXleakFh9ilOBgVhLhVb4GlONNSaysSi3Kh0lJc7AoifNeS7npLySQnliSmp2a\r
+       WpBaBJOV4eBQkuCd+QaoUbAoNT21Ii0zpwQhzcTBCTKcB2j4WZAa3uKCxNzizHSI/ClGXY4Z\r
+       fVPeMQqx5OXnpUqJ8z4EKRIAKcoozYObA0tRrxjFgd4S5j0PUsUDTG9wk14BLWECWjL59SqQ\r
+       JSWJCCmpBsb5Ps1l79xve7Fsmf5n62y52f0lk3SiGLxajq5sLJ2xb/LHGjX2FrlDlgu047WP\r
+       5x7k3lhSd6dkRtpZ0Q3RO1ucDGaFnRPbPm/xe38ziZt/L7u+u+/PvCjupIPWZcbzk5b1Hk2M\r
+       E0hqOqPgX9j0eeKh1YFHUhYdX3kyuVJH3nT1xZUlVaxrEjcosRRnJBpqMRcVJwIAxR6zCiwD        AAA=\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 13:37:55 -0000\r
+\r
+Quoth David Bremner on Jun 04 at  8:37 am:\r
+> Tomi Ollila <tomi.ollila@iki.fi> writes:\r
+> \r
+> > On Tue, Jun 04 2013, Austin Clements <amdragon@MIT.EDU> wrote:\r
+> >\r
+> >> I realize this already got pushed, but to me this seems like a\r
+> >> reversion for the 95% of users who haven't customized\r
+> >> notmuch-archive-tags and just want to know that archiving means\r
+> >> removing the inbox tag.  Why is this less confusing?  Users who have\r
+> >> customized notmuch-archive-tags will probably know that the "default"\r
+> >> doesn't apply to them.\r
+> \r
+> As a side note, this kind of thing is why I started a texinfo manual; I\r
+> don't really think reading docstrings is the best intro for a new user.\r
+> \r
+> > Can we have both -- i.e. something like (default: "-inbox") in the \r
+> > docstring. When entering c-h f notmuch-show-archive-thread\r
+> > The `notmuch-archive-tags' in text is a hyperlink to the documentation\r
+> > of notmuch-archive-tags (which shows its current value)...\r
+> \r
+> I don't really mind Tomi's suggestion, although in practice I think\r
+> following the hyperlink is also not so burdensome. I mainly didn't like\r
+> the places it mentioned "inbox" without mentioning the variable that\r
+> really controls it.\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