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

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

Date: Tue, 04 Jun 2013 08:37:01 -0300

To: Tomi Ollila, Austin Clements

Cc: notmuch@notmuchmail.org

From: David Bremner


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.

d


Thread: