From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS53758 23.128.96.0/24 X-Spam-Status: No, score=-3.8 required=3.0 tests=AWL,BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_PASS, SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by dcvr.yhbt.net (Postfix) with ESMTP id C3EF21F4B4 for ; Thu, 15 Apr 2021 09:16:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232059AbhDOJQ3 (ORCPT ); Thu, 15 Apr 2021 05:16:29 -0400 Received: from cloud.peff.net ([104.130.231.41]:53158 "EHLO cloud.peff.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231979AbhDOJQ3 (ORCPT ); Thu, 15 Apr 2021 05:16:29 -0400 Received: (qmail 9789 invoked by uid 109); 15 Apr 2021 09:16:06 -0000 Received: from Unknown (HELO peff.net) (10.0.1.2) by cloud.peff.net (qpsmtpd/0.94) with ESMTP; Thu, 15 Apr 2021 09:16:06 +0000 Authentication-Results: cloud.peff.net; auth=none Received: (qmail 14397 invoked by uid 111); 15 Apr 2021 09:16:07 -0000 Received: from coredump.intra.peff.net (HELO sigill.intra.peff.net) (10.0.0.2) by peff.net (qpsmtpd/0.94) with (TLS_AES_256_GCM_SHA384 encrypted) ESMTPS; Thu, 15 Apr 2021 05:16:07 -0400 Authentication-Results: peff.net; auth=none Date: Thu, 15 Apr 2021 05:16:05 -0400 From: Jeff King To: Junio C Hamano Cc: git@vger.kernel.org Subject: Re: [PATCH] doc: clarify "do not capitalize the first word" rule Message-ID: References: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org 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 > --- > > * 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