diff options
| author |  Philip Oakley <philipoakley@iee.org> | 2014-06-16 13:55:57 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2014-07-10 13:31:55 -0700 |
| commit | 0ae0e882b2dd8048e2096138561f0b2ab0cad454 (patch) | |
| tree | e80bd904a415b0bb5dc8a554eeefc2d59a7a2930 | |
| parent | Merge branch 'jc/rev-parse-argh-dashed-multi-words' into maint (diff) | |
| download | tgif-0ae0e882b2dd8048e2096138561f0b2ab0cad454.tar.xz | |
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>
| -rw-r--r-- | Documentation/CodingGuidelines | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index f424dbd75c..f4137c68ff 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 |