Re: [PATCH] doc: sparse-checkout: Fix list markers
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- May 28, 2025, 07:20 UTC
- Message-ID
- <CAPig+cTdN=x2GXGW2p_g_k4jgC0eQmjW5zLsWhJm-PP7eMBTiQ@mail.gmail.com>
- In-Reply-To
- <d8d8c10d-4f4f-4fde-8b91-b979e2931fad@app.fastmail.com>
On Wed, May 28, 2025 at 2:58 AM Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com> wrote:
Show 8 quoted lines
> On Mon, Apr 21, 2025, at 14:41, oneee via GitGitGadget wrote: > > Changed the list markers from a mix of "(1)" and "(b)" to a > > consistent numeric format "(1)", "(2)" for clarity and consistency. > > Reading the message I thought it was about a larger change to > consistently use one style over the other. But you are fixing one > application of inline lists to use either numeric or alphabetic(?), > specifically falling on numeric.
I seem to recall that I had a similar reaction when I originally read the commit message.
Show 6 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)`.
This does make it clearer.
Show 8 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.
As such, the patch itself looks obviously correct and is a definite improvement as-is. It's not clear why it didn't get picked up; perhaps it just fell through the cracks.