From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] doc: clarify "do not capitalize the first word" rule
Date: Thu, 15 Apr 2021 05:16:05 -0400 [thread overview]
Message-ID: <YHgEVZ/vN5hEAgoQ@coredump.intra.peff.net> (raw)
In-Reply-To: <xmqq7dl4whl6.fsf@gitster.g>
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@pobox.com>
> ---
>
> * 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
prev parent reply other threads:[~2021-04-15 9:16 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-14 23:51 [PATCH] doc: clarify "do not capitalize the first word" rule Junio C Hamano
2021-04-15 9:16 ` Jeff King [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=YHgEVZ/vN5hEAgoQ@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).