[PATCH 4/8] man: clarify search --exclude documentation
On Wed, 20 Jun 2012 21:08:05 +0100, Mark Walters wrote: > > I have reviewed all the new parts of this series (judged as being > patches 3-8) and the changes made to my two patches and they are all > fine (with one small comment below). Patch 1/8 does need a proper review > though as it ended up more intrusive than I would have liked. > > > +Messages matching search.tag_exclude are called "excluded messages". > > My one comment is that this is not quite true if the corresponding tag > is in the query. Since you are defining the term it would be nice to > mention that, but I can't see a clean wording. How about: A message is called "excluded" if it matches at least one tag in search.tag_exclude that does not appear explicitly in the search terms. Or less densely: Let "excluded tags" be the set of tags listed in search.tag_exclude, minus any tags which appear explicitly in the search terms. A message is an "excluded message" if it matches one or more excluded tags. Peter
[PATCH 4/8] man: clarify search --exclude documentation
Peter Wang writes: > On Wed, 20 Jun 2012 21:08:05 +0100, Mark Walters gmail.com> wrote: >> >> I have reviewed all the new parts of this series (judged as being >> patches 3-8) and the changes made to my two patches and they are all >> fine (with one small comment below). Patch 1/8 does need a proper review >> though as it ended up more intrusive than I would have liked. >> >> > +Messages matching search.tag_exclude are called "excluded messages". >> >> My one comment is that this is not quite true if the corresponding tag >> is in the query. Since you are defining the term it would be nice to >> mention that, but I can't see a clean wording. > > How about: > > A message is called "excluded" if it matches at least one tag > in search.tag_exclude that does not appear explicitly in the search > terms. I think this wording is excellent (and prefer it to the less dense wording). Best wishes Mark > Or less densely: > > Let "excluded tags" be the set of tags listed in search.tag_exclude, > minus any tags which appear explicitly in the search terms. > A message is an "excluded message" if it matches one or more > excluded tags. > > Peter
Re: [PATCH 4/8] man: clarify search --exclude documentation
On Wed, 20 Jun 2012 21:08:05 +0100, Mark Walters markwalters1...@gmail.com wrote: I have reviewed all the new parts of this series (judged as being patches 3-8) and the changes made to my two patches and they are all fine (with one small comment below). Patch 1/8 does need a proper review though as it ended up more intrusive than I would have liked. +Messages matching search.tag_exclude are called excluded messages. My one comment is that this is not quite true if the corresponding tag is in the query. Since you are defining the term it would be nice to mention that, but I can't see a clean wording. How about: A message is called excluded if it matches at least one tag in search.tag_exclude that does not appear explicitly in the search terms. Or less densely: Let excluded tags be the set of tags listed in search.tag_exclude, minus any tags which appear explicitly in the search terms. A message is an excluded message if it matches one or more excluded tags. Peter ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH 4/8] man: clarify search --exclude documentation
Highlight "excluded messages" as a piece of jargon with a meaning that may not be obvious. Be explicit about the effects of search --exclude=true and --exclude=false. --- man/man1/notmuch-search.1 | 14 -- 1 files changed, 12 insertions(+), 2 deletions(-) diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1 index 5c72c4b..003b742 100644 --- a/man/man1/notmuch-search.1 +++ b/man/man1/notmuch-search.1 @@ -116,8 +116,18 @@ Limit the number of displayed results to N. .TP 4 .BR \-\-exclude=(true|false|flag) -Specify whether to omit messages matching search.tag_exclude from the -search results (the default) or not. The extra option +Messages matching search.tag_exclude are called "excluded messages". +This option specifies whether to omit excluded messages in the search +process. + +The default value, +.BR true , +prevents excluded messages from matching the search terms. + +.B false +allows excluded messages to match search terms and appear in displayed +results. Excluded messages are still marked in the relevant outputs. + .B flag only has an effect when .B --output=summary -- 1.7.4.4
[PATCH 4/8] man: clarify search --exclude documentation
I have reviewed all the new parts of this series (judged as being patches 3-8) and the changes made to my two patches and they are all fine (with one small comment below). Patch 1/8 does need a proper review though as it ended up more intrusive than I would have liked. > +Messages matching search.tag_exclude are called "excluded messages". My one comment is that this is not quite true if the corresponding tag is in the query. Since you are defining the term it would be nice to mention that, but I can't see a clean wording. This should not hold up the series as it your wording is clearly an improvement on the current wording. Best wishes Mark
Re: [PATCH 4/8] man: clarify search --exclude documentation
I have reviewed all the new parts of this series (judged as being patches 3-8) and the changes made to my two patches and they are all fine (with one small comment below). Patch 1/8 does need a proper review though as it ended up more intrusive than I would have liked. +Messages matching search.tag_exclude are called excluded messages. My one comment is that this is not quite true if the corresponding tag is in the query. Since you are defining the term it would be nice to mention that, but I can't see a clean wording. This should not hold up the series as it your wording is clearly an improvement on the current wording. Best wishes Mark ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
