From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>
To: "Jean-Noël Avila" <jean-noel.avila@scantech•com>,
"Josh Soref" <gitgitgadget@gmail•com>,
git@vger•kernel.org
Subject: Re: [PATCH] doc: flock of small fixes to various documentation files
Date: Thu, 18 Dec 2025 09:05:44 +0100 [thread overview]
Message-ID: <843711d8-00c5-4747-972e-e705e14d85b4@app.fastmail.com> (raw)
In-Reply-To: <876ee36d-610b-4df6-9297-96b38f106c6c@scantech.com>
On Wed, Dec 17, 2025, at 14:45, Jean-Noël Avila wrote:
> Le 15/12/2025 à 23:50, Kristoffer Haugsbakk a écrit :
>>[snip]
>>
>> Could this fruitfully be split into at least two commits?
>>
>> I just think these are two different categories.
>
> For me these changes are so straightforward that splitting/grouping
> seemed overkill. But, I understand your point. Style vs. pure formatting
> is a good approach, even if here the style is not about the approach to
> writing the documentation.
>
>>
>> Is that just an academic concern? Well, in my experience it is very
>> pleasant to pickaxe through a snippet of text, stumble upon clearly
>> marked commits like
>>
>> • Use USA spelling
>> • Fix articles (the/a/an)
>> • *: typos
>>
>> and just race past them. Because I am looking for the original
>> motivation for some phrasing (say), typos and missing articles and all,
>> and these commits are simple to bunny hop. But here, fixing a missing
>> parentheses is mixed together with
>>
>> Replace: less than `<n>`, where `<n>` represents a number of bytes,
>> With: less than `<n>` bytes
>>
>> And now I might have to pause and think which implicated change this is
>> about for my purposes; a subjective-but-good change or a
>> fix-objective-mistake change. Because that matters when I want to know
>> why the text is phrased in a certain way.
>>
>
> OK, will split in two.
Thanks. Your consideration of this point is enough for me. Appreciated.
>>[snip]
>>
>
> Not the purpose of this commit, but maybe, it would make sense to stress
> out that the first sentence for explaining an option should describe
> bluntly its positive action expressed in imperative mood, with no
> ceremony. After this first sentence, the negative equivalient, more
> context, more precision or use cases can be described.
That sounds excellent.
>[snip]
next prev parent reply other threads:[~2025-12-18 8:06 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-15 20:23 [PATCH] doc: flock of small fixes to various documentation files Jean-Noël Avila via GitGitGadget
2025-12-15 22:50 ` Kristoffer Haugsbakk
2025-12-17 13:45 ` Jean-Noël Avila
2025-12-18 8:05 ` Kristoffer Haugsbakk [this message]
2025-12-19 9:34 ` Kristoffer Haugsbakk
2025-12-19 18:54 ` [PATCH v2 0/2] " Jean-Noël Avila via GitGitGadget
2025-12-19 18:54 ` [PATCH v2 1/2] doc: fix asciidoc markup issues in several files Jean-Noël Avila via GitGitGadget
2025-12-21 17:13 ` Kristoffer Haugsbakk
2025-12-19 18:54 ` [PATCH v2 2/2] doc: correct minor wording issues Jean-Noël Avila via GitGitGadget
2025-12-21 17:13 ` Kristoffer Haugsbakk
2025-12-22 4:42 ` Junio C Hamano
2025-12-21 17:12 ` [PATCH v2 0/2] doc: flock of small fixes to various documentation files Kristoffer Haugsbakk
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=843711d8-00c5-4747-972e-e705e14d85b4@app.fastmail.com \
--to=kristofferhaugsbakk@fastmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitgitgadget@gmail$(echo .)com \
--cc=jean-noel.avila@scantech$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox