summaryrefslogtreecommitdiff
path: root/Documentation/CodingGuidelines
diff options
context:
space:
mode:
authorPhilip Oakley <philipoakley@iee.org>2014-06-16 12:55:57 (GMT)
committerJunio C Hamano <gitster@pobox.com>2014-07-10 20:31:55 (GMT)
commit0ae0e882b2dd8048e2096138561f0b2ab0cad454 (patch)
treee80bd904a415b0bb5dc8a554eeefc2d59a7a2930 /Documentation/CodingGuidelines
parent9a597edc831038b8c449bd3e527ca2976e4e55a6 (diff)
downloadgit-0ae0e882b2dd8048e2096138561f0b2ab0cad454.zip
git-0ae0e882b2dd8048e2096138561f0b2ab0cad454.tar.gz
git-0ae0e882b2dd8048e2096138561f0b2ab0cad454.tar.bz2
doc: give some guidelines for error messages
Clarify error message puntuation to reduce review workload. Signed-off-by: Philip Oakley <philipoakley@iee.org> Helped-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/CodingGuidelines')
-rw-r--r--Documentation/CodingGuidelines9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index f424dbd..f4137c6 100644
--- 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