From: Jeff King <peff@peff.net>
Date: Mon, 01 Apr 2019 13:08:04 GMT
Subject: Re: [PATCH v1 1/2] Documentation/rev-list-options: wrap --date=<format> block with "--"
Message-ID: <20190401130804.GA11664@sigill.intra.peff.net>
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