Re: [PATCH v3 1/1] docs: rewrite the documentation of the text and eol attributes

From: Felipe Contreras <felipe.contreras@gmail.com>
Date: May 2, 2023, 16:27 UTC
Message-ID: <645139edf1a0_1ba2d29474@chronos.notmuch>
In-Reply-To: <20230502041725.7zbv3i4srdb7fqrg@tb-raspi4>

Torsten Bögershausen wrote:

Show 12 quoted lines

> 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