diff options
author | Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr> | 2019-03-06 14:04:45 +0100 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-03-13 11:14:10 +0900 |
commit | 0dbd305fe7b1c6394e24ef598898ef6cebd42956 (patch) | |
tree | 90b1cad595cf9179d3a88e3247834a9e95ede63f /Documentation/RelNotes/2.6.4.txt | |
parent | mingw: allow building with an MSYS2 runtime v3.x (diff) | |
download | tgif-0dbd305fe7b1c6394e24ef598898ef6cebd42956.tar.xz |
doc/CodingGuidelines: URLs and paths as monospace
The current documentation uses both quotes (italics) and backquotes
(monospace) to render URLs and pathnames, which is inconsistent.
Document a best practice in CodingGuidelines to help reduce
inconsistencies in the future.
We set the best practice to using backquotes, since:
* It is already an established practice. For exemple:
$ git grep "'[^']/*[^']'" | wc -l
206
$ git grep '`[^`]/*[^`]`' | wc -l
690
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
inconsistent formatting, and that it would be good to do
something about it.
* It may be debatable whether path names need to be typed in
monospace but having them in italics is really unusual.
Signed-off-by: Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr>
Signed-off-by: Nathan BERBEZIER <nathan.berbezier@etu.univ-lyon1.fr>
Signed-off-by: Pablo CHABANNE <pablo.chabanne@etu.univ-lyon1.fr>
Signed-off-by: Matthieu MOY <matthieu.moy@univ-lyon1.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/RelNotes/2.6.4.txt')
0 files changed, 0 insertions, 0 deletions