From 47f0b04417887525936da49fc0ae52a7236535c6 Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Tue, 4 Jun 2013 09:30:07 +0300 Subject: [PATCH] Re: [PATCH] emacs: remove hardcoded defaults values from docstrings --- 4d/1b7a1d5d47912027a99faa904def6cd4c0eccb | 118 ++++++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 4d/1b7a1d5d47912027a99faa904def6cd4c0eccb diff --git a/4d/1b7a1d5d47912027a99faa904def6cd4c0eccb b/4d/1b7a1d5d47912027a99faa904def6cd4c0eccb new file mode 100644 index 000000000..a69f67697 --- /dev/null +++ b/4d/1b7a1d5d47912027a99faa904def6cd4c0eccb @@ -0,0 +1,118 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 35844431FAF + for ; Mon, 3 Jun 2013 23:30:26 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id k7OLuVM7VLbP for ; + Mon, 3 Jun 2013 23:30:18 -0700 (PDT) +Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34]) + by olra.theworths.org (Postfix) with ESMTP id 81BE5431FAE + for ; Mon, 3 Jun 2013 23:30:18 -0700 (PDT) +Received: from guru.guru-group.fi (localhost [IPv6:::1]) + by guru.guru-group.fi (Postfix) with ESMTP id 106A8100030; + Tue, 4 Jun 2013 09:30:08 +0300 (EEST) +From: Tomi Ollila +To: Austin Clements , david@tethera.net +Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings +In-Reply-To: <20130604040102.GJ5999@mit.edu> +References: <1370181885-23021-1-git-send-email-david@tethera.net> + <20130604040102.GJ5999@mit.edu> +User-Agent: Notmuch/0.15.2+168~gf91ff62 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-unknown-linux-gnu) +X-Face: HhBM'cA~ +MIME-Version: 1.0 +Content-Type: text/plain +Cc: notmuch@notmuchmail.org, David Bremner +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Tue, 04 Jun 2013 06:30:26 -0000 + +On Tue, Jun 04 2013, Austin Clements wrote: + +> I realize this already got pushed, but to me this seems like a +> reversion for the 95% of users who haven't customized +> notmuch-archive-tags and just want to know that archiving means +> removing the inbox tag. Why is this less confusing? Users who have +> customized notmuch-archive-tags will probably know that the "default" +> doesn't apply to them. + +Can we have both -- i.e. something like (default: "-inbox") in the +docstring. When entering c-h f notmuch-show-archive-thread +The `notmuch-archive-tags' in text is a hyperlink to the documentation +of notmuch-archive-tags (which shows its current value)... + + +Tomi + +> +> Quoth david@tethera.net on Jun 02 at 11:04 am: +>> From: David Bremner +>> +>> These functions refer to default values of variables, but it seems +>> less confusing and less likely to get out of date to just allow the +>> user to follow the help cross-reference links. +>> --- +>> emacs/notmuch-show.el | 14 ++++++-------- +>> 1 file changed, 6 insertions(+), 8 deletions(-) +>> +>> another proposed change from our notmuch-pick discussions. +>> +>> diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el +>> index 613e666..600e802 100644 +>> --- a/emacs/notmuch-show.el +>> +++ b/emacs/notmuch-show.el +>> @@ -1835,10 +1835,9 @@ search results instead." +>> "Archive each message in thread. +>> +>> Archive each message currently shown by applying the tag changes +>> -in `notmuch-archive-tags' to each (remove the \"inbox\" tag by +>> -default). If a prefix argument is given, the messages will be +>> -\"unarchived\", i.e. the tag changes in `notmuch-archive-tags' +>> -will be reversed. +>> +in `notmuch-archive-tags' to each. If a prefix argument is given, +>> +the messages will be \"unarchived\", i.e. the tag changes in +>> +`notmuch-archive-tags' will be reversed. +>> +>> Note: This command is safe from any race condition of new messages +>> being delivered to the same thread. It does not archive the +>> @@ -1865,10 +1864,9 @@ buffer." +>> "Archive the current message. +>> +>> Archive the current message by applying the tag changes in +>> -`notmuch-archive-tags' to it (remove the \"inbox\" tag by +>> -default). If a prefix argument is given, the message will be +>> -\"unarchived\", i.e. the tag changes in `notmuch-archive-tags' +>> -will be reversed." +>> +`notmuch-archive-tags' to it. If a prefix argument is given, the +>> +message will be \"unarchived\", i.e. the tag changes in +>> +`notmuch-archive-tags' will be reversed." +>> (interactive "P") +>> (when notmuch-archive-tags +>> (apply 'notmuch-show-tag-message +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch -- 2.26.2