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

diff --git a/4d/1b7a1d5d47912027a99faa904def6cd4c0eccb b/4d/1b7a1d5d47912027a99faa904def6cd4c0eccb
new file mode 100644 (file)
index 0000000..a69f676
--- /dev/null
+++ b/4d/1b7a1d5d47912027a99faa904def6cd4c0eccb
@@ -0,0 +1,118 @@
+Return-Path: <tomi.ollila@iki.fi>\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 35844431FAF\r
+       for <notmuch@notmuchmail.org>; Mon,  3 Jun 2013 23:30:26 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       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 k7OLuVM7VLbP for <notmuch@notmuchmail.org>;\r
+       Mon,  3 Jun 2013 23:30:18 -0700 (PDT)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id 81BE5431FAE\r
+       for <notmuch@notmuchmail.org>; Mon,  3 Jun 2013 23:30:18 -0700 (PDT)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id 106A8100030;\r
+       Tue,  4 Jun 2013 09:30:08 +0300 (EEST)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: Austin Clements <amdragon@MIT.EDU>, david@tethera.net\r
+Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings\r
+In-Reply-To: <20130604040102.GJ5999@mit.edu>\r
+References: <1370181885-23021-1-git-send-email-david@tethera.net>\r
+       <20130604040102.GJ5999@mit.edu>\r
+User-Agent: Notmuch/0.15.2+168~gf91ff62 (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Tue, 04 Jun 2013 09:30:07 +0300\r
+Message-ID: <m2ppw275hs.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+Cc: notmuch@notmuchmail.org, David Bremner <bremner@debian.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 06:30:26 -0000\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
+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
+\r
+Tomi\r
+\r
+>\r
+> Quoth david@tethera.net on Jun 02 at 11:04 am:\r
+>> From: David Bremner <bremner@debian.org>\r
+>> \r
+>> These functions refer to default values of variables, but it seems\r
+>> less confusing and less likely to get out of date to just allow the\r
+>> user to follow the help cross-reference links.\r
+>> ---\r
+>>  emacs/notmuch-show.el | 14 ++++++--------\r
+>>  1 file changed, 6 insertions(+), 8 deletions(-)\r
+>> \r
+>> another proposed change from our notmuch-pick discussions.\r
+>> \r
+>> diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
+>> index 613e666..600e802 100644\r
+>> --- a/emacs/notmuch-show.el\r
+>> +++ b/emacs/notmuch-show.el\r
+>> @@ -1835,10 +1835,9 @@ search results instead."\r
+>>    "Archive each message in thread.\r
+>>  \r
+>>  Archive each message currently shown by applying the tag changes\r
+>> -in `notmuch-archive-tags' to each (remove the \"inbox\" tag by\r
+>> -default). If a prefix argument is given, the messages will be\r
+>> -\"unarchived\", i.e. the tag changes in `notmuch-archive-tags'\r
+>> -will be reversed.\r
+>> +in `notmuch-archive-tags' to each. If a prefix argument is given,\r
+>> +the messages will be \"unarchived\", i.e. the tag changes in\r
+>> +`notmuch-archive-tags' will be reversed.\r
+>>  \r
+>>  Note: This command is safe from any race condition of new messages\r
+>>  being delivered to the same thread. It does not archive the\r
+>> @@ -1865,10 +1864,9 @@ buffer."\r
+>>    "Archive the current message.\r
+>>  \r
+>>  Archive the current message by applying the tag changes in\r
+>> -`notmuch-archive-tags' to it (remove the \"inbox\" tag by\r
+>> -default). If a prefix argument is given, the message will be\r
+>> -\"unarchived\", i.e. the tag changes in `notmuch-archive-tags'\r
+>> -will be reversed."\r
+>> +`notmuch-archive-tags' to it. If a prefix argument is given, the\r
+>> +message will be \"unarchived\", i.e. the tag changes in\r
+>> +`notmuch-archive-tags' will be reversed."\r
+>>    (interactive "P")\r
+>>    (when notmuch-archive-tags\r
+>>      (apply 'notmuch-show-tag-message\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r