Re: [PATCH] doc: sparse-checkout: Fix list markers

From: oneee <kimww0306@gmail.com>
Date: May 30, 2025, 03:43 UTC
Message-ID: <CABXyHXoCuwAUqiQPxE82mV4n0PQtY1zopD+rJDb+oyTkR8qwyg@mail.gmail.com>
In-Reply-To: <4c1f645b-42fb-40b9-987e-08ce9e057e01@app.fastmail.com>

(I'm resending this email since the previous message was blocked due to accidently containing HTML. Thanks for your understanding!)

I'm sorry for the delay.

On Wed, May 28, 2025 at 3:58 PM Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com> wrote:

Show 9 quoted lines

>
> I would write it as:
>
>     doc: sparse-checkout: use consistent inline list style
>
>     Fix this inline list to use a single style, namely numeric, instead of
>     `(1)` followed by `(b)`.
>
> (Numeric or numeral, I’m not sure)

Thanks for the suggestion. I'll update the message as you wrote.

Show 7 quoted lines

>
> > Signed-off-by: onee-only <kimww0306@gmail.com>
>
> I’m not saying the following is not the case.  But FYI the project
> demands that commit identification needs to be your real name.
>
> Just saying in case it is a pseudonym.

I wasn't aware of it. I'll change it into my real name. Thanks for pointing it out.

On Wed, May 28, 2025 at 4:21 PM Eric Sunshine <sunshine@sunshineco.com> wrote:

Show 16 quoted lines

>
> > > +     word "patterns"), and (2) the sparse specification might
> >
> > I would also use a semicolon to separate `1` and `2`.  I think this is
> > the correct style for any list introduced by a colon:
> >
> >     see here: (1) ...; (2) ...; and (5) ...
> >
> > Because then you can use commas freely inside each point.
>
> I'd like to push back on this suggestion, at least in the context of
> this particular patch, the purpose of which is to fix an actual
> problem in the documentation. The sort of improvement you suggest
> probably ought to be done as a separate patch, but let's not make it
> seem as if we are heaping extra work on the patch submitter; it's more
> important to get the fix itself landed.

I'd like to apply it to the same PR in GitHub, producing an additional commit. (I don't fully understand how the system works, sorry).

Thank you all for the reviews!