summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2014-07-22 10:28:59 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2014-07-22 10:28:59 -0700
commit0d854fc1e35c145f81d97c4565bd6c07a7d47f19 (patch)
tree6670dff4de0d4217a8375254db37e8e8ccb30b09
parentMerge branch 'zk/log-graph-showsig' into maint (diff)
parentdoc: give some guidelines for error messages (diff)
downloadtgif-0d854fc1e35c145f81d97c4565bd6c07a7d47f19.tar.xz
Merge branch 'po/error-message-style' into maint
* po/error-message-style: doc: give some guidelines for error messages
-rw-r--r--Documentation/CodingGuidelines9
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