git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Jeff King <peff@peff.net>
Cc: Felipe Contreras <felipe.contreras@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH 1/2] doc: git-checkout: trivial callout cleanup
Date: Wed, 03 May 2023 10:44:14 -0700	[thread overview]
Message-ID: <xmqqzg6lqpht.fsf@gitster.g> (raw)
In-Reply-To: 20230425061029.GA4015844@coredump.intra.peff.net

Jeff King <peff@peff.net> writes:

> The first hunk seems less obviously good to me. We're not part of a
> list, so there's no continuation. We might say that it is good to always
> stick the callout list directly adjacent to the associated code block,
> since it does matter in other cases. But dropping the blank lines
> between the paragraph-sized callout blocks makes the source less
> readable, and empty lines between list elements are a pretty normal
> thing in asciidoc.
>
> That said, I don't feel _too_ strongly about it, so I'm OK with the
> patch as-is.

I agree with the conclusion.  

The first hunk may be iffy (in the sense that "it is not
cut-and-dried better than the original"), but the change makes the
postimage of that hunk look similar to the postimage of the second
hunk, and adopting it as our local rule to alwys stick the callout
list to the associated block gives us more consistent look, that is
good, too.

  parent reply	other threads:[~2023-05-03 17:44 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-18  7:00 [PATCH 0/2] doc: git-checkout: trivial style improvements Felipe Contreras
2023-04-18  7:00 ` [PATCH 1/2] doc: git-checkout: trivial callout cleanup Felipe Contreras
2023-04-19 19:37   ` Junio C Hamano
2023-04-24 13:28     ` Felipe Contreras
2023-04-25  0:02       ` Junio C Hamano
2023-04-25  6:10         ` Jeff King
2023-04-27 22:09           ` Felipe Contreras
2023-05-02 10:18             ` Jeff King
2023-05-02 16:05               ` Felipe Contreras
2023-05-03  6:09               ` Junio C Hamano
2023-05-03 13:46                 ` Felipe Contreras
2023-05-03 17:44           ` Junio C Hamano [this message]
2023-04-27 21:30         ` Felipe Contreras
2023-04-18  7:00 ` [PATCH 2/2] doc: git-checkout: reorganize examples Felipe Contreras
2023-04-19 19:37   ` Junio C Hamano

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqzg6lqpht.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=felipe.contreras@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).