Andrew's git
/
gitweb.git
/ diff
summary
|
log
|
commit
| diff |
tree
commit
grep
author
committer
pickaxe
?
re
Merge branch 'po/error-message-style' into maint
author
Junio C Hamano
<gitster@pobox.com>
Tue, 22 Jul 2014 17:28:59 +0000
(10:28 -0700)
committer
Junio C Hamano
<gitster@pobox.com>
Tue, 22 Jul 2014 17:28:59 +0000
(10:28 -0700)
* po/error-message-style:
doc: give some guidelines for error messages
Documentation/CodingGuidelines
patch
|
blob
|
history
raw
(from parent 1:
a1991f1
)
diff --git
a/Documentation/CodingGuidelines
b/Documentation/CodingGuidelines
index f424dbd75c80abb4d6fecce18f6fc25859bdcb00..f4137c68ff80647644cc1f3d45d24457f505e2a0 100644
(file)
--- a/
Documentation/CodingGuidelines
+++ b/
Documentation/CodingGuidelines
@@
-264,6
+264,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