Re: [PATCH] doc: clarify "do not capitalize the first word" rule

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, Apr 14, 2021 at 04:51:17PM -0700, Junio C Hamano wrote:

> The same "do not capitalize the first word" rule is applied to both
> our patch titles and error messages, but the existing description
> was fuzzy in two aspects.
> 
>  * For error messages, it was not said that this was only about the
>    first word that begins the sentence.
> 
>  * For both, it was not clear when a capital letter there was not an
>    error.  We avoid capitalizing the first word when the only reason
>    you would capitalize it is because it happens to be the first
>    word in the sentence.  If a proper noun that is usually spelled
>    in caps happens to come at the beginning of the sentence, that is
>    not a reason to downcase it.
> 
> Signed-off-by: Junio C Hamano <gitster@xxxxxxxxx>
> ---
> 
>  * I saw in the GGG inbox a well-intended patch that took the "do
>    not capitalize" rule too far, but with documentation unclear, it
>    was understandable, so here is to remedy the situation.

After reading the patch, I wouldn't have thought it needed to be spelled
out, but if you saw a case in the wild, it doesn't hurt to be as clear
as possible.

The patch text itself looks good to me.

-Peff



[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux