Thread (4 messages) 4 messages, 3 authors, 2023-10-23

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

From: Rubén Justo <hidden>
Date: 2023-10-23 20:17:39

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

Just for reference, to avoid confusion, this is technically the fourth
version.
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 <redacted>
---
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 [off-list ref]

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.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help