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

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

Date: Tue, 4 Jun 2013 09:37:38 -0400

To: David Bremner

Cc: Tomi Ollila, notmuch@notmuchmail.org

From: Austin Clements


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?

Thread: