Skip to content

Commit 092bf77

Browse files
committed
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
2 parents fdef940 + 151b6c2 commit 092bf77

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

Documentation/CodingGuidelines

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,12 @@ Error Messages
498498

499499
- Do not end error messages with a full stop.
500500

501-
- Do not capitalize ("unable to open %s", not "Unable to open %s")
501+
- Do not capitalize the first word, only because it is the first word
502+
in the message ("unable to open %s", not "Unable to open %s"). But
503+
"SHA-3 not supported" is fine, because the reason the first word is
504+
capitalized is not because it is at the beginning of the sentence,
505+
but because the word would be spelled in capital letters even when
506+
it appeared in the middle of the sentence.
502507

503508
- Say what the error is first ("cannot open %s", not "%s: cannot open")
504509

Documentation/SubmittingPatches

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,13 @@ If in doubt which identifier to use, run `git log --no-merges` on the
117117
files you are modifying to see the current conventions.
118118

119119
[[summary-section]]
120-
It's customary to start the remainder of the first line after "area: "
121-
with a lower-case letter. E.g. "doc: clarify...", not "doc:
122-
Clarify...", or "githooks.txt: improve...", not "githooks.txt:
123-
Improve...".
120+
The title sentence after the "area:" prefix omits the full stop at the
121+
end, and its first word is not capitalized unless there is a reason to
122+
capitalize it other than because it is the first word in the sentence.
123+
E.g. "doc: clarify...", not "doc: Clarify...", or "githooks.txt:
124+
improve...", not "githooks.txt: Improve...". But "refs: HEAD is also
125+
treated as a ref" is correct, as we spell `HEAD` in all caps even when
126+
it appears in the middle of a sentence.
124127

125128
[[meaningful-message]]
126129
The body should provide a meaningful commit message, which:

0 commit comments

Comments
 (0)