From: Jeff King <peff@peff.net>
To: Todd Zullinger <tmz@pobox.com>
Cc: git@vger.kernel.org,
"brian m. carlson" <sandals@crustytoothpaste.net>,
"Martin Ågren" <martin.agren@gmail.com>,
"SZEDER Gábor" <szeder.dev@gmail.com>
Subject: Re: [PATCH v1 1/2] Documentation/rev-list-options: wrap --date=<format> block with "--"
Date: Mon, 1 Apr 2019 09:08:04 -0400 [thread overview]
Message-ID: <20190401130804.GA11664@sigill.intra.peff.net> (raw)
In-Reply-To: <20190330183001.16624-2-tmz@pobox.com>
On Sat, Mar 30, 2019 at 02:30:00PM -0400, Todd Zullinger wrote:
> Using "+" to continue multiple list items is more tedious and
> error-prone than wrapping the entire block with "--" block markers.
>
> When using asciidoctor, the list items after the --date=iso list items
> are incorrectly formatted when using "+" continuation. Use "--" block
> markers to correctly format the block.
>
> When using asciidoc there is no change in how the content is rendered.
This seems like an asciidoctor bug, though I think this kind of
list-within-a-list stuff is inherently a bit heuristic-driven just due
to the syntax.
I do agree that the result after your patch is more readable, so I think
I prefer it even if the asciidoctor bug were fixed. I suspect we could
be using "--" blocks for readability in more places (I don't think it's
worth going on a hunt to convert old spots, but something to keep in
mind as we write new documentation).
-Peff
next prev parent reply other threads:[~2019-04-01 13:08 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-30 18:29 [PATCH v1 0/2] minor asciidoc/tor formatting fixes Todd Zullinger
2019-03-30 18:30 ` [PATCH v1 1/2] Documentation/rev-list-options: wrap --date=<format> block with "--" Todd Zullinger
2019-04-01 13:08 ` Jeff King [this message]
2019-04-05 1:20 ` Todd Zullinger
2019-03-30 18:30 ` [PATCH v1 2/2] Documentation/git-status: fix titles in porcelain v2 section Todd Zullinger
2019-04-01 13:18 ` Jeff King
2019-04-05 1:26 ` Todd Zullinger
2019-04-03 8:49 ` Jeff Hostetler
2019-04-05 1:32 ` Todd Zullinger
2019-04-03 9:26 ` [PATCH v1 0/2] minor asciidoc/tor formatting fixes Martin Ågren
2019-04-05 1:40 ` Todd Zullinger
2019-04-05 10:23 ` Martin Ågren
2019-04-05 22:51 ` [PATCH 0/2] a few more " Todd Zullinger
2019-04-06 9:16 ` Martin Ågren
2019-04-10 0:37 ` [PATCH v2 " Todd Zullinger
2019-04-10 3:09 ` Junio C Hamano
2019-04-10 0:37 ` [PATCH v2 1/2] Documentation/git-show-branch: avoid literal {apostrophe} Todd Zullinger
2019-04-10 0:37 ` [PATCH v2 2/2] Documentation/git-svn: improve asciidoctor compatibility Todd Zullinger
2019-04-05 22:51 ` [PATCH 1/2] Documentation/git-show-branch: drop last use of {apostrophe} Todd Zullinger
2019-04-06 9:21 ` Martin Ågren
2019-04-05 22:51 ` [PATCH 2/2] Documentation/git-svn: improve asciidoctor compatibility Todd Zullinger
2019-04-06 9:31 ` Martin Ågren
2019-04-10 0:41 ` Todd Zullinger
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=20190401130804.GA11664@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=martin.agren@gmail.com \
--cc=sandals@crustytoothpaste.net \
--cc=szeder.dev@gmail.com \
--cc=tmz@pobox.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.
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).