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>
Philip Oakley committed
Jun 16, 2014 at 13:55 UTC
0ae0e882b2dd8048e2096138561f0b2ab0cad454
1 file changed
+9
Documentation/CodingGuidelines
+9
@@ -264,6 +264,15 @@ For Python scripts:
264
documentation for version 2.6 does not mention this prefix, it has
265
been supported since version 2.6.0.
266
267
+Error Messages
268
+
269
+ - Do not end error messages with a full stop.
270
+
271
+ - Do not capitalize ("unable to open %s", not "Unable to open %s")
272
+
273
+ - Say what the error is first ("cannot open %s", not "%s: cannot open")
274
+
275
+
276
Writing Documentation:
277
278
Most (if not all) of the documentation pages are written in the