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 C2CD0431FB6 for ; Tue, 4 Jun 2013 06:37:54 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: -0.7 X-Spam-Level: X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 RnpqIao62csw for ; Tue, 4 Jun 2013 06:37:45 -0700 (PDT) Received: from dmz-mailsec-scanner-5.mit.edu (dmz-mailsec-scanner-5.mit.edu [18.7.68.34]) by olra.theworths.org (Postfix) with ESMTP id 0B6BC431FAE for ; Tue, 4 Jun 2013 06:37:44 -0700 (PDT) X-AuditID: 12074422-b7f5b6d00000095d-2f-51adeda868ca Received: from mailhub-auth-1.mit.edu ( [18.9.21.35]) by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP id 9C.70.02397.8ADEDA15; Tue, 4 Jun 2013 09:37:44 -0400 (EDT) Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id r54DbgVw020085; Tue, 4 Jun 2013 09:37:43 -0400 Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91]) (authenticated bits=0) (User authenticated as amdragon@ATHENA.MIT.EDU) by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r54DbeFZ019617 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT); Tue, 4 Jun 2013 09:37:41 -0400 Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.80) (envelope-from ) id 1UjrQh-0007yV-Hf; Tue, 04 Jun 2013 09:37:39 -0400 Date: Tue, 4 Jun 2013 09:37:38 -0400 From: Austin Clements To: David Bremner Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings Message-ID: <20130604133738.GL5999@mit.edu> References: <1370181885-23021-1-git-send-email-david@tethera.net> <20130604040102.GJ5999@mit.edu> <8738syrtsy.fsf@zancas.localnet> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <8738syrtsy.fsf@zancas.localnet> User-Agent: Mutt/1.5.21 (2010-09-15) X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFprJKsWRmVeSWpSXmKPExsUixCmqrLvi7dpAg6uPVC1utHYzWly/OZPZ 4s3KeawOzB6Hvy5k8Xi26hazx5ZD75kDmKO4bFJSczLLUov07RK4Mn4vnMZW8I+r4u164wbG xxxdjJwcEgImEts+f2WEsMUkLtxbz9bFyMUhJLCPUWJW8y0oZwOjxKuG++wQzikmiYVtS6Ay Sxgl1i1ZywLSzyKgItHR/p4ZxGYT0JDYtn852FwRAVWJq9smAzVwcDAL2EpMvRIDEhYW8JG4 v/EaG4jNK6Atse/7DFaImWsYJQ5fbWGBSAhKnJz5BMxmFtCSuPHvJRPEHGmJ5f/AXuAU0JU4 t/Qo2FpRoBOmnNzGNoFRaBaS7llIumchdC9gZF7FKJuSW6Wbm5iZU5yarFucnJiXl1qka6qX m1mil5pSuokRFOrsLko7GH8eVDrEKMDBqMTDq7hlTaAQa2JZcWXuIUZJDiYlUd7nt9YGCvEl 5adUZiQWZ8QXleakFh9ilOBgVhLhVb4GlONNSaysSi3Kh0lJc7AoifNeS7npLySQnliSmp2a WpBaBJOV4eBQkuCd+QaoUbAoNT21Ii0zpwQhzcTBCTKcB2j4WZAa3uKCxNzizHSI/ClGXY4Z fVPeMQqx5OXnpUqJ8z4EKRIAKcoozYObA0tRrxjFgd4S5j0PUsUDTG9wk14BLWECWjL59SqQ JSWJCCmpBsb5Ps1l79xve7Fsmf5n62y52f0lk3SiGLxajq5sLJ2xb/LHGjX2FrlDlgu047WP 5x7k3lhSd6dkRtpZ0Q3RO1ucDGaFnRPbPm/xe38ziZt/L7u+u+/PvCjupIPWZcbzk5b1Hk2M E0hqOqPgX9j0eeKh1YFHUhYdX3kyuVJH3nT1xZUlVaxrEjcosRRnJBpqMRcVJwIAxR6zCiwD AAA= Cc: Tomi Ollila , 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 13:37:55 -0000 Quoth David Bremner on Jun 04 at 8:37 am: > 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. Right. I think we should both reference the variable and say what the default behavior is (there's no reason not to do both). But isn't that what these docstrings used to do?