Re: [PATCH v2] docs: fix formatting and grammar
- From
Jeff King <peff@peff.net>
- Date
- Jun 1, 2017, 15:53 UTC
- Message-ID
- <20170601155311.urqaxmjagqgiogmh@sigill.intra.peff.net>
- In-Reply-To
- <20170601103703.12216-1-adam@dinwoodie.org>
On Thu, Jun 01, 2017 at 11:37:03AM +0100, Adam Dinwoodie wrote:
Show 20 quoted lines
> 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 it means asciidoc is failing to correctly detect which > text should be monospaced and which shouldn't. > > To avoid this, remove the extraneous spaces from the text to be > monospaced. It would also be possible to fix the formatting by > switching to asciidoc's ++ monospace format markers and still have the > space characters included in the monospace text, but the spaces aren't > necessary and not having them keeps the markup simpler. > > Also include a minor grammar fix suggested by Jeff while we're changing > these lines. > > Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org> > Helped-by: Jeff King <peff@peff.net> > --- > Documentation/git-pull.txt | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-)
This looks fine, although...
Show 5 quoted lines
> In order to determine what URL to use to fetch from, the value > of the configuration `remote.<origin>.url` is consulted > -and if there is not any such variable, the value on `URL: ` line > +and if there is not any such variable, the value on the `URL:` line > in `$GIT_DIR/remotes/<origin>` file is used.
...I should have read to the end of the sentence. It should also be "in the `$GIT_DIR/remotes/<origin>` file". Or just drop "file".
-Peff