Skip to content

Commit 7591e2c

Browse files
committed
Merge branch 'po/error-message-style'
* po/error-message-style: doc: give some guidelines for error messages
2 parents ce33d61 + 0ae0e88 commit 7591e2c

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,15 @@ For Python scripts:
404404
documentation for version 2.6 does not mention this prefix, it has
405405
been supported since version 2.6.0.
406406

407+
Error Messages
408+
409+
- Do not end error messages with a full stop.
410+
411+
- Do not capitalize ("unable to open %s", not "Unable to open %s")
412+
413+
- Say what the error is first ("cannot open %s", not "%s: cannot open")
414+
415+
407416
Writing Documentation:
408417

409418
Most (if not all) of the documentation pages are written in the

0 commit comments

Comments
 (0)