git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Ramsay Jones <ramsay@ramsayjones.plus.com>
Cc: GIT Mailing-list <git@vger.kernel.org>,
	 Patrick Steinhardt <ps@pks.im>, Elijah Newren <newren@gmail.com>
Subject: Re: [RFC PATCH 3/4] doc: sparse-checkout.adoc: fix asciidoc warnings
Date: Fri, 26 Sep 2025 08:46:08 -0700	[thread overview]
Message-ID: <xmqqms6hcj3z.fsf@gitster.g> (raw)
In-Reply-To: <19964f5e-f553-4eda-8a62-7d0aa3017657@ramsayjones.plus.com> (Ramsay Jones's message of "Fri, 26 Sep 2025 01:26:14 +0100")

Ramsay Jones <ramsay@ramsayjones.plus.com> writes:

> Signed-off-by: Ramsay Jones <ramsay@ramsayjones.plus.com>
> ---
>  Documentation/technical/sparse-checkout.adoc | 38 ++++++++++----------
>  1 file changed, 19 insertions(+), 19 deletions(-)

The same comment about explaining your changes applies to this one.

> -=== Terminology ===
> +== Terminology ==

We've seen this in the previous step, too.  No comment, no objection.

> -=== Known bugs ===
> +== Known bugs ==

Ditto.

>  This list used to be a lot longer (see e.g. [1,2,3,4,5,6,7,8,9]), but we've
>  been working on it.
>  
> -0. Behavior A is not well supported in Git.  (Behavior B didn't used to
> +1. Behavior A is not well supported in Git.  (Behavior B didn't used to
>     be either, but was the easier of the two to implement.)
>
> -1. am and apply:
> +2. am and apply:
> ...  
> -6. Performance issues; see:
> +7. Performance issues; see:
>      https://lore.kernel.org/git/CABPp-BEkJQoKZsQGCYioyga_uoDQ6iBeW+FKr8JhyuuTMK1RDw@mail.gmail.com/

OK. They want our numbered list to be base-1, first item being
labeled with "1.", not "0.".  I think the majority of readers would
prefer that way while reading the source text (I thought markdown
formatters would renumber them anyway, but I probably am mistaken
here, like in many other things).  Curious that we have "." after
these numbers, though.


      reply	other threads:[~2025-09-26 15:46 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-26  0:26 [RFC PATCH 3/4] doc: sparse-checkout.adoc: fix asciidoc warnings Ramsay Jones
2025-09-26 15:46 ` Junio C Hamano [this message]

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=xmqqms6hcj3z.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=newren@gmail.com \
    --cc=ps@pks.im \
    --cc=ramsay@ramsayjones.plus.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).