undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'po/error-message-style'

Browse Source 
* po/error-message-style:
  doc: give some guidelines for error messages
This commit is contained in:
Junio C Hamano 2014-07-16 11:33:03 -07:00
commit 7591e2c53c
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/CodingGuidelines
View File

@ -404,6 +404,15 @@ For Python scripts:
documentation for version 2.6 does not mention this prefix, it has documentation for version 2.6 does not mention this prefix, it has
been supported since version 2.6.0. 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: Writing Documentation:
Most (if not all) of the documentation pages are written in the Most (if not all) of the documentation pages are written in the