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

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 30, 2025, 05:00 UTC
Message-ID: <CAPig+cQbchWLMH+pTVfLHwFshaex2vhC8Pk57EC4U-vch00ZDA@mail.gmail.com>
In-Reply-To: <CABXyHXoCuwAUqiQPxE82mV4n0PQtY1zopD+rJDb+oyTkR8qwyg@mail.gmail.com>

On Thu, May 29, 2025 at 11:43 PM oneee <kimww0306@gmail.com> wrote:

Show 19 quoted lines

> On Wed, May 28, 2025 at 4:21 PM Eric Sunshine <sunshine@sunshineco.com> wrote:
> > > > +     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).

You're welcome to submit an additional patch implementing Kristoffer's suggestion. Normally, it would make sense to send them both as a two-patch series, however, I'm not so sure that that would be a good idea in this case. The reason I question it is that the original patch is an obvious and uncontroversial fix, however, Kristoffer's suggestion -- because it is a subjective change -- may get pushback from reviewers. If it does get pushback, then that pushback could hold up the entire series as discussion ensues, thus slowing or even completely derailing the original "fix" patch from being accepted.