From: Austin Clements <amdragon@MIT.EDU>
To: David Bremner <david@tethera.net>
Cc: Tomi Ollila <tomi.ollila@iki.fi>, notmuch@notmuchmail.org
Subject: Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
Date: Tue, 4 Jun 2013 09:37:38 -0400 [thread overview]
Message-ID: <20130604133738.GL5999@mit.edu> (raw)
In-Reply-To: <8738syrtsy.fsf@zancas.localnet>
Quoth David Bremner on Jun 04 at 8:37 am:
> Tomi Ollila <tomi.ollila@iki.fi> writes:
>
> > On Tue, Jun 04 2013, Austin Clements <amdragon@MIT.EDU> 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?
next prev parent reply other threads:[~2013-06-04 13:37 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-02 14:04 [PATCH] emacs: remove hardcoded defaults values from docstrings david
2013-06-02 14:29 ` [PATCH] emacs: add `notmuch-archive-tags' cross references in docstrings david
2013-06-02 14:32 ` [PATCH] emacs: remove hardcoded defaults values from docstrings Tomi Ollila
2013-06-02 17:47 ` Mark Walters
2013-06-03 0:03 ` David Bremner
2013-06-04 4:01 ` Austin Clements
2013-06-04 6:30 ` Tomi Ollila
2013-06-04 11:37 ` David Bremner
2013-06-04 13:37 ` Austin Clements [this message]
2013-06-04 14:22 ` David Bremner
2013-06-05 6:05 ` Tomi Ollila
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20130604133738.GL5999@mit.edu \
--to=amdragon@mit.edu \
--cc=david@tethera.net \
--cc=notmuch@notmuchmail.org \
--cc=tomi.ollila@iki.fi \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).