Andrew's git
/
gitweb.git
/ diff
summary
|
log
|
commit
| diff |
tree
commit
grep
author
committer
pickaxe
?
re
Merge branch 'po/error-message-style'
author
Junio C Hamano
<gitster@pobox.com>
Wed, 16 Jul 2014 18:33:03 +0000
(11:33 -0700)
committer
Junio C Hamano
<gitster@pobox.com>
Wed, 16 Jul 2014 18:33:03 +0000
(11:33 -0700)
* po/error-message-style:
doc: give some guidelines for error messages
Documentation/CodingGuidelines
patch
|
blob
|
history
raw
(from parent 1:
ce33d61
)
diff --git
a/Documentation/CodingGuidelines
b/Documentation/CodingGuidelines
index 4d90c77c7bd643b11df8d3094efe142493df53b9..894546dd75416fcf09542096a67b2f22a7d0de7a 100644
(file)
--- a/
Documentation/CodingGuidelines
+++ b/
Documentation/CodingGuidelines
@@
-404,6
+404,15
@@
For Python scripts:
documentation for version 2.6 does not mention this prefix, it has
been supported since version 2.6.0.
+Error Messages
+
+ - Do not end error messages with a full stop.
+
+ - Do not capitalize ("unable to open %s", not "Unable to open %s")
+
+ - Say what the error is first ("cannot open %s", not "%s: cannot open")
+
+
Writing Documentation:
Most (if not all) of the documentation pages are written in the