Re: [PATCH] doc/for-each-ref: explicitly specify option names
- Date: Fri, 1 Sep 2017 18:03:23 -0400
- From: Jeff King <peff@xxxxxxxx>
- Subject: Re: [PATCH] doc/for-each-ref: explicitly specify option names
On Fri, Sep 01, 2017 at 04:49:31PM +0200, Kevin Daudt wrote:
> For count, sort and format, only the argument names were listed under
> OPTIONS, not the option names.
> Add the option names to make it clear the options exist
Yeah, this looks much better. I could see having a general "<format>"
section if it was used as the argument to multiple options, but that's
not what's going on here. And even if it were, the right thing is to
have individual "--foo=<format>" and "--bar=<format>" items in the list,
and let them refer to a more general section on formats.