Re: [PATCH 17/16] config: add core.commentString

[Chris Torek <chris.torek@gmail.com>]

Assuming the implementation continues as suggested, I'll mention
here that I really like this note:

On Wed, Mar 27, 2024 at 1:19 AM Jeff King <peff@peff.net> wrote:
> +Note that these two variables are aliases of each other, and in modern
> +versions of Git you are free to use a string (e.g., `//` or `⁑⁕⁑`) with
> +`commentChar`. Versions of Git prior to v2.45.0 will ignore
> +`commentString` but will reject a value of `commentChar` that consists
> +of more than a single ASCII byte. If you plan to use your config with
> +older and newer versions of Git, you may want to specify both:

One of the big things I think is missing from existing Git documentation
(and would, alas, be a huge effort to provide) is backwards-compatibility
notes. People are often stuck with old versions of software, at least
during initial bringup, for a variety of reasons, and such notes can
be quite helpful.

Examples of modern systems that have extensive notes include
Python, where the documentation often says "new in 3.7" or
whatever, and Go, where the automatically-built documentation
notes which version of Go introduced some new function.

I'm not exactly volunteering here for the heavy lifting though. :-)

Chris