From 0ae0e882b2dd8048e2096138561f0b2ab0cad454 Mon Sep 17 00:00:00 2001 From: Philip Oakley Date: Mon, 16 Jun 2014 13:55:57 +0100 Subject: doc: give some guidelines for error messages Clarify error message puntuation to reduce review workload. Signed-off-by: Philip Oakley Helped-by: Jeff King Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'Documentation') diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index f424dbd75..f4137c68f 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 -- cgit v1.2.1