Re: [PATCH] kernel: events: use correct articles in comments
From: Mark Rutland
Date: Thu Jul 05 2018 - 08:28:00 EST
On Thu, Jul 05, 2018 at 01:26:08PM +0100, Mark Rutland wrote:
> On Thu, Jul 05, 2018 at 01:27:56PM +0200, Tobias Tefke wrote:
> > These words are pronounced (and start) with a vowel sound.
> > Therefore the article we use has to be 'an' instead of 'a'.
> >
> > Signed-off-by: Tobias Tefke <tobias.tefke@xxxxxxxxxxxx>
>
> To clarify Alexander's reply, there's some guidance on writing commit
> messages in section 2 of:
>
> Documentation/process/submitting-patches.rst
>
> The basic idea is that the commit message should make sense on its own,
> even if you can't see the diff. Describe the problem first, any
> caveats, then the solution taken (in the imperative tense).
>
> e.g. the above could be:
>
> ----
> Some of the comments in the kernel events code use articles incorrectly,
> 'a' for words beginning with a vowel sound, where 'an' should be used.
Whoops, dropped a word here. That should say:
Some of the comments in the kernel events code use articles incorrectly,
using 'a' for words beginning with a vowel sound, where 'an' should be
used.
Mark.