Merge branch 'po/error-message-style'

* po/error-message-style: doc: give some guidelines for error messages
2014-07-16 11:33:03 -07:00 · 2014-07-16 11:33:03 -07:00 · 7591e2c53c
commit 7591e2c53c
parent ce33d61096 0ae0e882b2
1 changed files with 9 additions and 0 deletions
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@ -404,6 +404,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