git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: "Martin Ågren" <martin.agren@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 1/4] git-column.txt: fix section header
Date: Sun, 16 Dec 2018 05:51:24 -0500	[thread overview]
Message-ID: <20181216105123.GD13704@sigill.intra.peff.net> (raw)
In-Reply-To: <20181215112742.1475882-2-martin.agren@gmail.com>

On Sat, Dec 15, 2018 at 12:27:39PM +0100, Martin Ågren wrote:

> We have too few dashes under "Examples", which causes Asciidoctor to not
> pick it up as a section header, but to instead just render the dashes
> literally. This also seems to confuse Asciidoctor about dashes in
> general around here. It misinterprets the listing blocks in this
> section, again rendering the dashes literally.
> 
> Make sure we have as many dashes as we have characters in "Examples".
> This fixes the section-issue and, somehow, makes the listing blocks
> render correctly.

Yeah, the mis-matched title-and-dashes thing has bitten us several
times. I think this one just post-dates the last round of fixing.

The "somehow" here is that the mismatched dashes appear to be the start
of a code listing block, making the whole example section into one big
listing (which isn't properly closed, generating a warning).

And that's why in the context:

>  EXAMPLES
> -------
> +--------
>  
>  Format data by columns:
>  ------------

We _don't_ need to match up the dashes for "Format data...". That is
meant to be a listing block (and arguably should use a shorter string of
dashes to make that intent more obvious).

-Peff

  reply	other threads:[~2018-12-16 10:51 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-15 11:27 [PATCH 0/4] A few Asciidoctor-fixes Martin Ågren
2018-12-15 11:27 ` [PATCH 1/4] git-column.txt: fix section header Martin Ågren
2018-12-16 10:51   ` Jeff King [this message]
2018-12-16 14:27     ` Martin Ågren
2018-12-15 11:27 ` [PATCH 2/4] git-init.txt: do not nest open blocks Martin Ågren
2018-12-16 10:55   ` Jeff King
2018-12-15 11:27 ` [PATCH 3/4] rev-list-options.txt: " Martin Ågren
2018-12-16 10:56   ` Jeff King
2018-12-15 11:27 ` [PATCH 4/4] git-status.txt: render tables correctly under Asciidoctor Martin Ågren
2018-12-16 10:59   ` Jeff King
2018-12-16 14:28     ` [PATCH v2 0/3] A few Asciidoctor-fixes Martin Ågren
2018-12-16 14:28       ` [PATCH v2 1/3] git-column.txt: fix section header Martin Ågren
2018-12-16 14:28       ` [PATCH v2 2/3] Documentation: do not nest open blocks Martin Ågren
2018-12-16 14:28       ` [PATCH v2 3/3] git-status.txt: render tables correctly under Asciidoctor Martin Ågren
2018-12-16 16:19       ` [PATCH v2 0/3] A few Asciidoctor-fixes Jeff King
2018-12-16 10:44 ` [PATCH 0/4] " Jeff King
2018-12-16 14:34   ` Martin Ågren
2018-12-16 16:17     ` Jeff King

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=20181216105123.GD13704@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=martin.agren@gmail.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).