[PATCH] emacs: remove hardcoded defaults values from docstrings
On Tue, Jun 04 2013, David Bremner wrote: > Austin Clements writes: >> >> 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? > > Looking at the old docstrings in notmuch-show.el, I agree they basically > implement Tomi's suggestion. While I think copying default values of > variables into docstrings creates some minor maintainability traps > (since we then need to remember to look at all the places a variable is > referenced if we change the default value), I'm willing to revert the > patch if people think the tradeoff of better usability is worth it. Well, revert would be the worst option -- maintainability traps there and no reference to the variable used ;/ So either what we currently have in repository (and merge Mark's similar patches) or have both. In addition to my quick suggestion, what is been seen in notmuch-show.el docstrings this is what `split-string' has: ... If SEPARATORS is non-nil, it should be a regular expression matching text which separates, but is not part of, the substrings. If nil it defaults to `split-string-default-separators', normally "[ \f\t\n\r\v]+", and OMIT-NULLS is forced to t. ... By looking the code, doc hardcoded, defconst split-string-default-separators -- from maintainability point of view those are close to each other... IMO what we currently have is OK, unless SomeOne(tm) provides a neat patch and agrees that maintainability is not really a problem here :D > It is unfortunate emacs doesn't provide a way to expand the current > value of a variable in the help string, but there we are. It probably > wouldn't be as easy to understand as hand crafted text in any case. We could have placeholders in *.el files and tune byte compiler to fill in the docstrings >;) Imagine the added bonus we get by the confusion that causes ! > d Tomi
[PATCH] emacs: remove hardcoded defaults values from docstrings
Austin Clements writes: > > 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? Looking at the old docstrings in notmuch-show.el, I agree they basically implement Tomi's suggestion. While I think copying default values of variables into docstrings creates some minor maintainability traps (since we then need to remember to look at all the places a variable is referenced if we change the default value), I'm willing to revert the patch if people think the tradeoff of better usability is worth it. It is unfortunate emacs doesn't provide a way to expand the current value of a variable in the help string, but there we are. It probably wouldn't be as easy to understand as hand crafted text in any case. d
[PATCH] emacs: remove hardcoded defaults values from docstrings
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?
[PATCH] emacs: remove hardcoded defaults values from docstrings
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. 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 at tethera.net on Jun 02 at 11:04 am: >> From: David Bremner >> >> 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 at notmuchmail.org > http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH] emacs: remove hardcoded defaults values from docstrings
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. d
Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
Austin Clements writes: > > 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? Looking at the old docstrings in notmuch-show.el, I agree they basically implement Tomi's suggestion. While I think copying default values of variables into docstrings creates some minor maintainability traps (since we then need to remember to look at all the places a variable is referenced if we change the default value), I'm willing to revert the patch if people think the tradeoff of better usability is worth it. It is unfortunate emacs doesn't provide a way to expand the current value of a variable in the help string, but there we are. It probably wouldn't be as easy to understand as hand crafted text in any case. d ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
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? ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
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. d ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH] emacs: remove hardcoded defaults values from docstrings
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. Quoth david at tethera.net on Jun 02 at 11:04 am: > From: David Bremner > > 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
Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
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. 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 da...@tethera.net on Jun 02 at 11:04 am: >> From: David Bremner >> >> 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 ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
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. Quoth da...@tethera.net on Jun 02 at 11:04 am: > From: David Bremner > > 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
[PATCH] emacs: remove hardcoded defaults values from docstrings
Mark Walters writes: > both of these LGTM +1. > > Note there are still some (an?) occurrences of this: eg > notmuch-search-archive-thread, and there is one in pick. But these might > as well go in anyway. pushed both, d
[PATCH] emacs: remove hardcoded defaults values from docstrings
both of these LGTM +1. Note there are still some (an?) occurrences of this: eg notmuch-search-archive-thread, and there is one in pick. But these might as well go in anyway. Best wishes Mark On Sun, 02 Jun 2013, david at tethera.net wrote: > From: David Bremner > > 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 > -- > 1.8.2.rc2 > > ___ > notmuch mailing list > notmuch at notmuchmail.org > http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH] emacs: remove hardcoded defaults values from docstrings
On Sun, Jun 02 2013, david at tethera.net wrote: > From: David Bremner > > 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. > --- LGTM. Tomi > 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 > -- > 1.8.2.rc2 > > ___ > notmuch mailing list > notmuch at notmuchmail.org > http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
Mark Walters writes: > both of these LGTM +1. > > Note there are still some (an?) occurrences of this: eg > notmuch-search-archive-thread, and there is one in pick. But these might > as well go in anyway. pushed both, d ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH] emacs: remove hardcoded defaults values from docstrings
From: David Bremner 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 -- 1.8.2.rc2
Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
both of these LGTM +1. Note there are still some (an?) occurrences of this: eg notmuch-search-archive-thread, and there is one in pick. But these might as well go in anyway. Best wishes Mark On Sun, 02 Jun 2013, da...@tethera.net wrote: > From: David Bremner > > 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 > -- > 1.8.2.rc2 > > ___ > notmuch mailing list > notmuch@notmuchmail.org > http://notmuchmail.org/mailman/listinfo/notmuch ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
On Sun, Jun 02 2013, da...@tethera.net wrote: > From: David Bremner > > 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. > --- LGTM. Tomi > 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 > -- > 1.8.2.rc2 > > ___ > notmuch mailing list > notmuch@notmuchmail.org > http://notmuchmail.org/mailman/listinfo/notmuch ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH] emacs: remove hardcoded defaults values from docstrings
From: David Bremner 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 -- 1.8.2.rc2 ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
