Re: [PATCH 01/34] CodingGuidelines: update and clarify command-line conventions

From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Sep 8, 2022, 07:46 UTC
Message-ID: <220908.865yhyl31c.gmgdl@evledraar.gmail.com>
In-Reply-To: <xmqqedwnszsz.fsf@gitster.g>

On Wed, Sep 07 2022, Junio C Hamano wrote:

Show 14 quoted lines

> Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:
>
>> + Use spacing around "|" token(s), but not on the inside of "[]()"
>> + tokens:
>> +   Do: [-q | --quiet]
>> +   Don't: [-q|--quiet]
>
> It is unclear what "but not on ..." in the description and it is
> still unclear with the examples.  Does this mean
>
> 	Don't: ( -q | --quiet )
>
> In other words, "on the inside of" above is meant to forbid spaces
> immediately after opening or before closing a [] or () pair?

Yes, that's what I was aiming for, and will obviously need to rephrase. I.e.:

 Don't: ( -q | --quiet)
 Do: (-q | --quiet)

> Other than that, I think these are good guidelines to have.

"Other than that" as in "let's fix that phrasing" or "let's not have that concept as part of these guidelines".

I think the phrasing obviously needs to be fixed, here I was just attempting to cover a blind spot where the guidelines said nothing, and I picked whatever was the most common convention (as the rest of the series shows).