diff options
| author | Junio C Hamano <gitster@pobox.com> | 2014-07-16 11:33:03 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-07-16 11:33:03 -0700 |
| commit | 7591e2c53c6f02626e376a98b5f95745fbfe108f (patch) | |
| tree | 59247b35b3873270f64d10e158f419a7fb177fbc | |
| parent | ce33d610969d2d39db3c3fe99fe5bae89dfab75a (diff) | |
| parent | 0ae0e882b2dd8048e2096138561f0b2ab0cad454 (diff) | |
| download | git-7591e2c53c6f02626e376a98b5f95745fbfe108f.tar.gz | |
Merge branch 'po/error-message-style'
* po/error-message-style:
doc: give some guidelines for error messages
| -rw-r--r-- | Documentation/CodingGuidelines | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 4d90c77c7b..894546dd75 100644 --- 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 |