Re: [PATCH v3] builtin/branch.c: adjust error messages to coding guidelines

From: Rubén Justo <rjusto@gmail.com>
Date: Oct 23, 2023, 20:17 UTC
Message-ID: <14df596a-d0ef-46aa-97c6-3c9f0da1975f@gmail.com>
In-Reply-To: <20231023160656.4341-1-isokenjune@gmail.com>

On 23-oct-2023 17:06:56, Isoken June Ibizugbe wrote:

Just for reference, to avoid confusion, this is technically the fourth version.

Show 8 quoted lines

> As per the CodingGuidelines document, it is recommended that error messages
> such as die(), error() and warning(), should start with a lowercase letter
> and should not end with a period.
> 
> This patch adjusts tests to match updated messages.
> 
> Signed-off-by: Isoken June Ibizugbe <isokenjune@gmail.com>
> ---

It is often convenient to include here, after this three dash line, a description of the changes introduced in the new iteration.

In this particular case, a range-diff is very helpful.

This is the range-diff with v2:

1:  a4e8bb1b4c ! 1:  c4ae0c1cce builtin/branch.c: adjust error messages to coding guidelines
    @@ Metadata
      ## Commit message ##
         builtin/branch.c: adjust error messages to coding guidelines
     
    -    As per the CodingGuidelines document, it is recommended that a single-line
    -    message provided to error messages such as die(), error() and warning(),
    -    should start with a lowercase letter and should not end with a period.
    -    Also this patch fixes the tests broken by the changes.
    +    As per the CodingGuidelines document, it is recommended that error messages
    +    such as die(), error() and warning(), should start with a lowercase letter
    +    and should not end with a period.
    +
    +    This patch adjusts tests to match updated messages.
     
         Signed-off-by: Isoken June Ibizugbe <isokenjune@gmail.com>

As we can see, the only difference is in the commit message.

The new wording is better; it avoids the distraction introduced in v2.

And, as Dragan suggested about /the other v3/, the wrapping is correct.

The rest of the patch is equal to the previous iteration (v2), which already seemed correct to me.

Thank you.