Thread (3 messages) flat view 3 messages, 3 authors, 2017-01-18

Re: [PATCH v3 1/5] doc: add documentation for OPT_STRING_LIST

From: Jacob Keller <hidden>
Date: 2017-01-18 21:11:10

On Wed, Jan 18, 2017 at 11:45 AM, Junio C Hamano [off-list ref] wrote:
I do not know if it is clear enough that 'option' in the last
sentence is a placeholder.  I then wondered if spelling it as
`--no-<long>` would make it a bit clearer, but that is ugly.
To be fair, this is exactly how the rest of the doc spells these
things, so I would rather be consistent with the doc as is, and a
future patch could clean this up. See OPT_SET_INT, for an example of
`--no-option`.

The "Reset the list" is an instruction to the end-users who interact
with a program written by readers of this document using
OPT_STRING_LIST(), and it feels a bit out of place.  Perhaps

        End users can reset the list by negating the option,
        i.e. passing "--no-<long>", on the command line.

I dunno.
Maybe we can rephrase this "The list is reset via `--no-option`"?

Thanks,
Jake
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help