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

[Tomi Ollila <tomi.ollila@iki.fi>]

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.

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)...


Tomi

>
> Quoth david@tethera.net on Jun 02 at 11:04 am:
>> From: David Bremner <bremner@debian.org>
>> 
>> These functions refer to default values of variables, but it seems
>> less confusing and less likely to get out of date to just allow the
>> user to follow the help cross-reference links.
>> ---
>>  emacs/notmuch-show.el | 14 ++++++--------
>>  1 file changed, 6 insertions(+), 8 deletions(-)
>> 
>> another proposed change from our notmuch-pick discussions.
>> 
>> diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
>> index 613e666..600e802 100644
>> --- a/emacs/notmuch-show.el
>> +++ b/emacs/notmuch-show.el
>> @@ -1835,10 +1835,9 @@ search results instead."
>>    "Archive each message in thread.
>>  
>>  Archive each message currently shown by applying the tag changes
>> -in `notmuch-archive-tags' to each (remove the \"inbox\" tag by
>> -default). If a prefix argument is given, the messages will be
>> -\"unarchived\", i.e. the tag changes in `notmuch-archive-tags'
>> -will be reversed.
>> +in `notmuch-archive-tags' to each. If a prefix argument is given,
>> +the messages will be \"unarchived\", i.e. the tag changes in
>> +`notmuch-archive-tags' will be reversed.
>>  
>>  Note: This command is safe from any race condition of new messages
>>  being delivered to the same thread. It does not archive the
>> @@ -1865,10 +1864,9 @@ buffer."
>>    "Archive the current message.
>>  
>>  Archive the current message by applying the tag changes in
>> -`notmuch-archive-tags' to it (remove the \"inbox\" tag by
>> -default). If a prefix argument is given, the message will be
>> -\"unarchived\", i.e. the tag changes in `notmuch-archive-tags'
>> -will be reversed."
>> +`notmuch-archive-tags' to it. If a prefix argument is given, the
>> +message will be \"unarchived\", i.e. the tag changes in
>> +`notmuch-archive-tags' will be reversed."
>>    (interactive "P")
>>    (when notmuch-archive-tags
>>      (apply 'notmuch-show-tag-message
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch