diff options
| author | Junio C Hamano <gitster@pobox.com> | 2014-07-22 10:28:59 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-07-22 10:28:59 -0700 |
| commit | 0d854fc1e35c145f81d97c4565bd6c07a7d47f19 (patch) | |
| tree | 6670dff4de0d4217a8375254db37e8e8ccb30b09 /Documentation | |
| parent | a1991f173460d4cc3bffecf4e2840ab74a8f3291 (diff) | |
| parent | 0ae0e882b2dd8048e2096138561f0b2ab0cad454 (diff) | |
| download | git-0d854fc1e35c145f81d97c4565bd6c07a7d47f19.tar.gz | |
Merge branch 'po/error-message-style' into maint
* po/error-message-style:
doc: give some guidelines for error messages
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/CodingGuidelines | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index f424dbd75c..f4137c68ff 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -264,6 +264,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 |