Re: [PATCH 2/2 v3] doc: format pathnames and URLs as monospace.
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Mar 13, 2019, 02:16 UTC
- Message-ID
- <xmqq5zsnfrhk.fsf@gitster-ct.c.googlers.com>
- In-Reply-To
- <8a8944a6-9559-74be-afee-e6af262412ab@gmail.com>
Andrei Rybak <rybak.a.v@gmail.com> writes:
Show 16 quoted lines
> On 2019-03-12 16:48, Eric Sunshine wrote: >> Thanks. A few comments: >> >> In patch 1/2: >> >> * drop the full stop from the first line of the commit message >> >> * s/futur/future/ in the commit message >> >> * s/There are false/& positives/ in the commit message >> >> * s/both, It/both, it/ > > Also, > > * s/inconsistant/inconsistent/ in the first paragraph of the commit message.
Here is what I have locally, with the above input, relative to what Matthieu reviewed.
Thanks, all.
1: ed3eba5cc5 ! 1: 0dbd305fe7 doc/CodingGuidelines: URLs and paths as monospace.
@@ -1,11 +1,11 @@
Author: Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr>
- doc/CodingGuidelines: URLs and paths as monospace.
+ doc/CodingGuidelines: URLs and paths as monospace
The current documentation uses both quotes (italics) and backquotes
- (monospace) to render URLs and pathnames, which is inconsistant.
+ (monospace) to render URLs and pathnames, which is inconsistent.
Document a best practice in CodingGuidelines to help reduce
- inconsistencies in the futur.
+ inconsistencies in the future.
We set the best practice to using backquotes, since:
@@ -17,8 +17,8 @@
$ git grep '`[^`]/*[^`]`' | wc -l
690
- There are false on both sides, but after a cursory look at the
- output of both, It doesn't seem the false positive rate is really
+ There are false positives on both sides, but after a cursory look at
+ the output of both, it doesn't seem the false positive rate is really
higher in the second case.
At least, this shows that the existing documentation uses
2: 38ffa25f88 = 2: 68ed71b53c doc: format pathnames and URLs as monospace.