All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Andrei Rybak <rybak.a.v@gmail.com>
Cc: git@vger.kernel.org, "Thomas Ackermann" <th.acker@arcor.de>,
	"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Junio C Hamano" <gitster@pobox.com>
Subject: Re: [PATCH] Documentation: render special characters correctly
Date: Thu, 29 Jul 2021 09:04:40 -0400	[thread overview]
Message-ID: <YQKnaCcfJaagTF/h@coredump.intra.peff.net> (raw)
In-Reply-To: <20210729110252.116214-1-rybak.a.v@gmail.com>

On Thu, Jul 29, 2021 at 01:02:52PM +0200, Andrei Rybak wrote:

> Three hyphens are rendered verbatim, so "--" has to be used to produce a
> dash.  There is no double arrow ("<->" is rendered as "<→"), so a left
> and right arrow "<-->" have to be combined for that.
> 
> So fix asciidoc output for special characters.  This is similar to fixes
> in commit de82095a95 (doc hash-function-transition: fix asciidoc output,
> 2021-02-05).

Thanks. I looked at the doc-diff output before and after this patch, and
they both seem like strict improvements.

The double-arrow thing is kind of weird to me in the first place,
though. I suspect it might be more clear if it just spelled out what it
is trying to say with words. Something like:

  The pruning feature doesn't actually care about branches. Instead, it
  will prune local refs tracking remote ones as a function of...

But I'm OK to leave that to do on top; the current code simply renders
incorrectly, and your patch is fixing that.

-Peff

      reply	other threads:[~2021-07-29 13:04 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-29 11:02 [PATCH] Documentation: render special characters correctly Andrei Rybak
2021-07-29 13:04 ` Jeff King [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=YQKnaCcfJaagTF/h@coredump.intra.peff.net \
    --to=peff@peff.net \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=rybak.a.v@gmail.com \
    --cc=th.acker@arcor.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.