Merge branch 'po/error-message-style' into maint

* po/error-message-style: doc: give some guidelines for error messages
git-mirror · Jul 22, 2014 · 0d854fc · 0d854fc
2 parents a1991f1 + 0ae0e88
commit 0d854fc
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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