From: Felipe Contreras <felipe.contreras@gmail.com>
To: "Torsten Bögershausen" <tboegi@web.de>,
"Alex Henrie" <alexhenrie24@gmail.com>
Cc: git@vger.kernel.org, eyvind.bernhardsen@gmail.com, gitster@pobox.com
Subject: Re: [PATCH v3 1/1] docs: rewrite the documentation of the text and eol attributes
Date: Tue, 02 May 2023 10:27:25 -0600 [thread overview]
Message-ID: <645139edf1a0_1ba2d29474@chronos.notmuch> (raw)
In-Reply-To: <20230502041725.7zbv3i4srdb7fqrg@tb-raspi4>
Torsten Bögershausen wrote:
> This looks much better, thanks.
> I have some minor comments:
> a) The commit message from above:
> > docs: rewrite the documentation of the text and eol attributes
>
> The word "doc" is used 2 times, that feel a little bit redundant
> (and should start with a uppercase letter)
>
> "Docs: rewrite the documentation of the text and eol attributes"
>
> Or may be shorter:
> "Rewrite the documentation of the text and eol attributes"
This suggestion goes against the Git guideline in SubmittingPatches [1]:
The title sentence after the "area:" prefix omits the full stop at the
end, and its first word is not capitalized (the omission of
capitalization applies only to the word after the "area:" prefix of
the title) unless there is a reason to capitalize it other than
because it is the first word in the sentence. E.g. "doc: clarify...",
not "doc: Clarify...", or "githooks.txt: improve...", not
"githooks.txt: Improve...".
If this is touching the documentation, it should have the "docs: "
prefix, or "doc: ".
[1] https://git-scm.com/docs/SubmittingPatches
--
Felipe Contreras
next prev parent reply other threads:[~2023-05-02 16:27 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-01 2:35 [PATCH v3 0/1] docs: rewrite the documentation of the text and eol attributes Alex Henrie
2023-05-01 2:35 ` [PATCH v3 1/1] " Alex Henrie
2023-05-02 4:17 ` Torsten Bögershausen
2023-05-02 5:59 ` Alex Henrie
2023-05-02 16:27 ` Felipe Contreras [this message]
2023-05-03 4:46 ` [PATCH v4 0/1] " Alex Henrie
2023-05-03 4:46 ` [PATCH v4 1/1] " Alex Henrie
2023-05-03 16:06 ` Junio C Hamano
2023-05-03 19:00 ` Torsten Bögershausen
2023-05-03 19:27 ` Junio C Hamano
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=645139edf1a0_1ba2d29474@chronos.notmuch \
--to=felipe.contreras@gmail.com \
--cc=alexhenrie24@gmail.com \
--cc=eyvind.bernhardsen@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=tboegi@web.de \
/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.
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 NNTP newsgroup(s).