From: David Bremner Date: Tue, 4 Jun 2013 11:37:01 +0000 (+2100) Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=fe8b92ead8ed92139c8e8809a144563978849a6b;p=notmuch-archives.git Re: [PATCH] emacs: remove hardcoded defaults values from docstrings --- diff --git a/7c/c2e5b48fced0f7fad270dfc49bd909d4ae9beb b/7c/c2e5b48fced0f7fad270dfc49bd909d4ae9beb new file mode 100644 index 000000000..5a0266d3e --- /dev/null +++ b/7c/c2e5b48fced0f7fad270dfc49bd909d4ae9beb @@ -0,0 +1,87 @@ +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 3E27C431FAF + for ; Tue, 4 Jun 2013 04:37:35 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -2.3 +X-Spam-Level: +X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_MED=-2.3] 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 RCZOqO5z2zwg for ; + Tue, 4 Jun 2013 04:37:23 -0700 (PDT) +Received: from tempo.its.unb.ca (tempo.its.unb.ca [131.202.1.21]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id C6C6A431FAE + for ; Tue, 4 Jun 2013 04:37:23 -0700 (PDT) +Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238]) + by tempo.its.unb.ca (8.13.8/8.13.8) with ESMTP id r54BbBuA008524; + Tue, 4 Jun 2013 08:37:11 -0300 +Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net + ([156.34.82.78] helo=zancas.localnet) + by tesseract.cs.unb.ca with esmtpsa + (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80) + (envelope-from ) + id 1UjpY2-0001Nm-UW; Tue, 04 Jun 2013 08:37:11 -0300 +Received: from bremner by zancas.localnet with local (Exim 4.80) + (envelope-from ) + id 1UjpXx-0005Un-5w; Tue, 04 Jun 2013 08:37:01 -0300 +From: David Bremner +To: Tomi Ollila , Austin Clements +Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings +In-Reply-To: +References: <1370181885-23021-1-git-send-email-david@tethera.net> + <20130604040102.GJ5999@mit.edu> +User-Agent: Notmuch/0.15.2+141~gd298af4 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-pc-linux-gnu) +Date: Tue, 04 Jun 2013 08:37:01 -0300 +Message-ID: <8738syrtsy.fsf@zancas.localnet> +MIME-Version: 1.0 +Content-Type: text/plain +X-Spam_bar: - +Cc: notmuch@notmuchmail.org +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 11:37:35 -0000 + +Tomi Ollila writes: + +> 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. + +As a side note, this kind of thing is why I started a texinfo manual; I +don't really think reading docstrings is the best intro for a new user. + +> 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)... + +I don't really mind Tomi's suggestion, although in practice I think +following the hyperlink is also not so burdensome. I mainly didn't like +the places it mentioned "inbox" without mentioning the variable that +really controls it. + +d +