development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-26 19:19:18 +00:00
Code Issues 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
parent ce33d61096 0ae0e882b2
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
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