Thread (11 messages) 11 messages, 6 authors, 2025-05-30

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

From: Eric Sunshine <hidden>
Date: 2025-05-28 07:21:00

On Wed, May 28, 2025 at 2:58 AM Kristoffer Haugsbakk
[off-list ref] wrote:
On Mon, Apr 21, 2025, at 14:41, oneee via GitGitGadget wrote:
quoted
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.
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.
quoted
+     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.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help