git-filter-branch.txt: wrap "maths" notation in backticks
authorMartin Ågren <martin.agren@gmail.com>
Mon, 3 Feb 2020 20:36:50 +0000 (21:36 +0100)
committerJunio C Hamano <gitster@pobox.com>
Tue, 4 Feb 2020 20:17:18 +0000 (12:17 -0800)
commite469afe158a9c8a4b2aa9a753f80d034a8fc7f05
tree3034a469ba11f6263de732d28b496c8289838b00
parent0ad714499976290d9a0229230cbe4efae930b8dc
git-filter-branch.txt: wrap "maths" notation in backticks

In this paragraph, we have a few instances of the '^' character, which
we give as "\^". This renders well with AsciiDoc ("^"), but Asciidoctor
renders it literally as "\^". Dropping the backslashes renders fine
with Asciidoctor, but not AsciiDoc...

An earlier version of this patch used "{caret}" instead of "^", which
avoided these escaping problems. The rendering was still so-so, though
-- these expressions end up set as normal text, similarly to when one
provides, e.g., computer code in the middle of running text, without
properly marking it with `backticks` to be monospaced.

As noted by Jeff King, this suggests actually wrapping these
expressions in backticks, setting them in monospace.

The lone "5" could be left as is or wrapped as `5`. Spell it out as
"five" instead -- this generally looks better anyway for small numbers
in the middle of text like this.

Suggested-by: Jeff King <peff@peff.net>
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-filter-branch.txt