diff options
| author | Junio C Hamano <gitster@pobox.com> | 2021-04-20 17:23:36 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-04-20 17:23:36 -0700 |
| commit | 092bf77e8cc1717b1924d6acb85f2d34bce09f50 (patch) | |
| tree | f90f6d805f79394081bec99efbc3d066b02568c4 /Documentation/CodingGuidelines | |
| parent | Merge branch 'ab/usage-error-docs' (diff) | |
| parent | doc: clarify "do not capitalize the first word" rule (diff) | |
| download | git-092bf77e8cc1717b1924d6acb85f2d34bce09f50.tar.gz git-092bf77e8cc1717b1924d6acb85f2d34bce09f50.zip | |
Merge branch 'jc/doc-do-not-capitalize-clarification'
Doc update for developers.
* jc/doc-do-not-capitalize-clarification:
doc: clarify "do not capitalize the first word" rule
Diffstat (limited to 'Documentation/CodingGuidelines')
| -rw-r--r-- | Documentation/CodingGuidelines | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 45465bc0c9..1ff6d8e2d2 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -498,7 +498,12 @@ Error Messages - Do not end error messages with a full stop. - - Do not capitalize ("unable to open %s", not "Unable to open %s") + - Do not capitalize the first word, only because it is the first word + in the message ("unable to open %s", not "Unable to open %s"). But + "SHA-3 not supported" is fine, because the reason the first word is + capitalized is not because it is at the beginning of the sentence, + but because the word would be spelled in capital letters even when + it appeared in the middle of the sentence. - Say what the error is first ("cannot open %s", not "%s: cannot open") |