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

From: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
Date: May 28, 2025, 06:56 UTC
Message-ID: <d8d8c10d-4f4f-4fde-8b91-b979e2931fad@app.fastmail.com>
In-Reply-To: <pull.1948.git.git.1745239300668.gitgitgadget@gmail.com>

> doc: sparse-checkout: Fix list markers

s/Fix/fix/. The initial word after the area should be lower-case. See `Documentation/SubmittingPatches` (SP), “describe-changes”.

On Mon, Apr 21, 2025, at 14:41, oneee via GitGitGadget wrote:

> From: onee-only <kimww0306@gmail.com>
>
> Changed the list markers from a mix of "(1)" and "(b)" to a
> consistent numeric format "(1)", "(2)" for clarity and consistency.

Commits are described in imperative mood (SB, “imperative-mood”).

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 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)

> 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.

> +	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.