Skip to content
  • Martin Ågren's avatar
    git-filter-branch.txt: wrap "maths" notation in backticks · e469afe1
    Martin Ågren authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    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: default avatarJeff King <peff@peff.net>
    Signed-off-by: default avatarMartin Ågren <martin.agren@gmail.com>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    e469afe1