Re: [PATCH] docs: fix literal quoted spaces
On Wed, May 31, 2017 at 04:06:24PM +0100, Adam Dinwoodie wrote: > When compiling the documentation, asciidoc thinks a backtick surrounded > by whitespace shouldn't be interpreted as marking the start or end of a > literal. In most cases, that's useful behaviour, but in the git-pull > documentation the space is clearly intended to be part of the monospace > formatted text. Good catch. > Instead, use + to avoid asciidoc's literal passthrough, and encode the > space as {sp}. In particular, this means asciidoc will correctly detect > the end of the monospace formatting, rather than having it continue past > the backtick. In these particular cases, is the space adding anything? Would a simpler fix be to just use: ...the value on `URL:` line We've had such headaches with other entities like {sp} between different asciidoc versions (not to mention asciidoctor) that I tend to reach for the simplest solution. (I'd also suggest the minor English correct of saying "_the_ URL line"; that's orthogonal to what you're trying to fix, but may make sense on top while we're here). -Peff
Re: [PATCH] docs: fix literal quoted spaces
Jeff King writes: > On Wed, May 31, 2017 at 04:06:24PM +0100, Adam Dinwoodie wrote: > >> When compiling the documentation, asciidoc thinks a backtick surrounded >> by whitespace shouldn't be interpreted as marking the start or end of a >> literal. In most cases, that's useful behaviour, but in the git-pull >> documentation the space is clearly intended to be part of the monospace >> formatted text. > > Good catch. > >> Instead, use + to avoid asciidoc's literal passthrough, and encode the >> space as {sp}. In particular, this means asciidoc will correctly detect >> the end of the monospace formatting, rather than having it continue past >> the backtick. > > In these particular cases, is the space adding anything? Would a simpler > fix be to just use: > > ...the value on `URL:` line > > We've had such headaches with other entities like {sp} between different > asciidoc versions (not to mention asciidoctor) that I tend to reach for > the simplest solution. Me, too (and no, I am not from AOL). If `URL:` is typeset correctly the approach to drop the space is much more preferred. > (I'd also suggest the minor English correct of saying "_the_ URL line"; > that's orthogonal to what you're trying to fix, but may make sense on > top while we're here). > > -Peff
Re: [PATCH] docs: fix literal quoted spaces
On Thu, Jun 01, 2017 at 11:06:18AM +0900, Junio C Hamano wrote: > Jeff King writes: > > > On Wed, May 31, 2017 at 04:06:24PM +0100, Adam Dinwoodie wrote: > > > >> Instead, use + to avoid asciidoc's literal passthrough, and encode the > >> space as {sp}. In particular, this means asciidoc will correctly detect > >> the end of the monospace formatting, rather than having it continue past > >> the backtick. > > > > In these particular cases, is the space adding anything? Would a simpler > > fix be to just use: > > > > ...the value on `URL:` line > > > > We've had such headaches with other entities like {sp} between different > > asciidoc versions (not to mention asciidoctor) that I tend to reach for > > the simplest solution. > > Me, too (and no, I am not from AOL). If `URL:` is typeset correctly > the approach to drop the space is much more preferred. I decided against that fix on the assumption that there was _some_ reason for including the space, even if I couldn't immediately see it. Given Junio wrote the original text and is now suggesting removing it, I'll respin the patch now. > > (I'd also suggest the minor English correct of saying "_the_ URL line"; > > that's orthogonal to what you're trying to fix, but may make sense on > > top while we're here). Sure. I'll include that in the follow up patch.