Re: Add missing period to DETAIL messages

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: Peter Smith <smithpb2250(at)gmail(dot)com>, Xiaopeng Wang <wxp_728(at)163(dot)com>
Cc: Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Add missing period to DETAIL messages
Date: 2026-04-15 18:26:22
Message-ID: e297aa41-0e81-43b1-9e43-a157df99f186@eisentraut.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 15.04.26 09:41, Peter Smith wrote:
> On Wed, Apr 15, 2026 at 3:48 PM Xiaopeng Wang <wxp_728(at)163(dot)com> wrote:
>>
> ...
>>
>> Looks good to me.
>>
>> A small comment is that, the commit message claims only “add missing period to DETAIL messages”, but apparently the patch also changes capitalization in many places, so the commit message should be updated.
>>
>
> Fair point. Thanks for your review!
>
> PSA v4 which has an improved commit message.

Most of these look good, but I don't think this is an improvement:

-DETAIL: syntax error at end of input
+DETAIL: syntax error at end of input.

The guidelines say that the detail message should be a sentence. But
this is not a sentence. Just adding a period doesn't make it a
sentence. IMO, having a period at the end of a thing that is not a
sentence is worse than not having it be a sentence. The latter just
violates our quality standards, the former is confusing for a user who
sees that particular output.

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Antonin Houska 2026-04-15 18:28:24 Re: Adding REPACK [concurrently]
Previous Message Tom Lane 2026-04-15 18:13:46 Re: Do we still need gen_node_support.pl's nodetag ABI stability check?