Re: [PATCH] notmuch(1): clarify documentation about --option/value separators
On Thu 2020-05-07 16:40:26 -0700, Carl Worth wrote: > On Thu, May 07 2020, Daniel Kahn Gillmor wrote: >> +separator. Except for boolean options (wihch would be ambiguous), a > > Misspelling of "which". And while I'm here, strictly speaking Boolean is > generally capitalized in English, (being one of those adjectives that is > derived from a proper noun). > > Otherwise, this looks like a good improvement to me. Thanks! Thanks for catching the "which" misspelling, which should obviously be fixed if/when the patch is applied. notmuch-search-terms(7) contains both capitalized and non-capitalized spellings of "boolean". I welcome capitalization cleanup for this over the whole codebase, and hope that a decision about this particular nit-pick isn't cause for delay of an otherwise uncontroversial improvement. --dkg signature.asc Description: PGP signature ___ notmuch mailing list notmuch@notmuchmail.org https://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] notmuch(1): clarify documentation about --option/value separators
Carl Worth writes: > On Thu, May 07 2020, Daniel Kahn Gillmor wrote: >> +separator. Except for boolean options (wihch would be ambiguous), a > > Misspelling of "which". And while I'm here, strictly speaking Boolean is > generally capitalized in English, (being one of those adjectives that is > derived from a proper noun). I pushed this to master with s/wihch/which/. I left boolean for a future patch since there are around 7 occurences in the docs, currently all lower case. d ___ notmuch mailing list notmuch@notmuchmail.org https://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] notmuch(1): clarify documentation about --option/value separators
On Thu, May 07 2020, Daniel Kahn Gillmor wrote: > +separator. Except for boolean options (wihch would be ambiguous), a Misspelling of "which". And while I'm here, strictly speaking Boolean is generally capitalized in English, (being one of those adjectives that is derived from a proper noun). Otherwise, this looks like a good improvement to me. Thanks! -Carl signature.asc Description: PGP signature ___ notmuch mailing list notmuch@notmuchmail.org https://notmuchmail.org/mailman/listinfo/notmuch
[PATCH] notmuch(1): clarify documentation about --option/value separators
id:CA+Tk8fzRiqxWpd=r8=DRvEewNZXUZgD7MKyRLB1A=r-lxxg...@mail.gmail.com started a thread of discussion that showed that the cli's current idiosyncrasies around dealing with boolean options were not understandable. This attempts to improve the documentation at least (actual changes to the API might be better, but have not reached consensus). Note that no one in the discussion thread identified any other (non-boolean) command-line options that cannot use space as a separator. If such an option is identified (or introduced in the future), it should be added explicitly to this part of the manual. Signed-off-by: Daniel Kahn Gillmor --- doc/man1/notmuch.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index d2cd8da5..3dcc646c 100644 --- a/doc/man1/notmuch.rst +++ b/doc/man1/notmuch.rst @@ -128,9 +128,9 @@ OPTION SYNTAX - All options accepting an argument can be used with '=' or ':' as a -separator. For the cases where it's not ambiguous (in particular -excluding boolean options), a space can also be used. The following -are all equivalent: +separator. Except for boolean options (wihch would be ambiguous), a +space can also be used as a separator. The following are all +equivalent: :: -- 2.26.2 ___ notmuch mailing list notmuch@notmuchmail.org https://notmuchmail.org/mailman/listinfo/notmuch
