From: Junio C Hamano <gitster@pobox.com>
To: Andrei Rybak <rybak.a.v@gmail.com>
Cc: Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr>,
Eric Sunshine <sunshine@sunshineco.com>,
Matthieu Moy <git@matthieu-moy.fr>,
Git List <git@vger.kernel.org>,
nathan.berbezier@etu.univ-lyon1.fr,
pablo.chabanne@etu.univ-lyon1.fr
Subject: Re: [PATCH 2/2 v3] doc: format pathnames and URLs as monospace.
Date: Wed, 13 Mar 2019 11:16:55 +0900 [thread overview]
Message-ID: <xmqq5zsnfrhk.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <8a8944a6-9559-74be-afee-e6af262412ab@gmail.com> (Andrei Rybak's message of "Tue, 12 Mar 2019 18:13:48 +0100")
Andrei Rybak <rybak.a.v@gmail.com> writes:
> 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.
next prev parent reply other threads:[~2019-03-13 2:16 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-06 13:04 [PATCH 1/2 v3] doc/CodingGuidelines: URLs and paths as monospace Corentin BOMPARD
2019-03-06 13:04 ` [PATCH 2/2 v3] doc: format pathnames and URLs " Corentin BOMPARD
2019-03-12 13:16 ` Matthieu Moy
2019-03-12 15:48 ` Eric Sunshine
2019-03-12 17:13 ` Andrei Rybak
2019-03-13 2:16 ` Junio C Hamano [this message]
2019-03-13 6:43 ` Eric Sunshine
2019-03-13 9:53 ` Matthieu Moy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq5zsnfrhk.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=corentin.bompard@etu.univ-lyon1.fr \
--cc=git@matthieu-moy.fr \
--cc=git@vger.kernel.org \
--cc=nathan.berbezier@etu.univ-lyon1.fr \
--cc=pablo.chabanne@etu.univ-lyon1.fr \
--cc=rybak.a.v@gmail.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).