public inbox for [email protected]  

help / color / mirror / Atom feed

From: Joe Conway <[email protected]>
To: Bruce Momjian <[email protected]>
Cc: Álvaro Herrera <[email protected]>
Cc: Nazir Bilal Yavuz <[email protected]>
Cc: PostgreSQL-development <[email protected]>
Cc: Thomas Munro <[email protected]>
Subject: Re: PG 18 release notes draft committed
Date: Wed, 28 May 2025 14:54:29 -0400
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
	<[email protected]>
	<[email protected]>
	<[email protected]>
	<[email protected]>

On 5/27/25 17:27, Bruce Momjian wrote:
> On Mon, May 26, 2025 at 10:20:08AM -0400, Joe Conway wrote:
>> On 5/23/25 09:47, Bruce Momjian wrote:
>> > On Fri, May 23, 2025 at 09:54:54AM +0200, Álvaro Herrera wrote:
>> > > I also think that showing an XML-ish format of a commit message is
>> > > unhelpful, not to mention hard to read.  Showing a few actual examples
>> > > would be better.
>> > 
>> > Agreed, but the XML came from Joe Conway so I am hesitant to remove it
>> > myself without feedback from him.
>> 
>> 
>> I am not married to it, but I would say that I find pure examples
>> confusing/ambiguous. To me at least the XML-ish specification is easier to
>> understand.
>> 
>> Perhaps both the specification as-is and one or two examples added?
> 
> Yeah, I think some people like syntax, others like examples.

What do you think about providing links into the archives for good 
representative log messages rather than making up a contrived example 
and/or copy/pasting them into the wiki page itself?

Also, looking at the wiki page, my inclination would be to add an 
"Examples" section at the bottom of the wiki page -- does that work or 
do you think it ought to go just under the "General layout" syntax section?

-- 
Joe Conway
PostgreSQL Contributors Team
RDS Open Source Databases
Amazon Web Services: https://aws.amazon.com

view thread (147+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected], [email protected], [email protected]
  Subject: Re: PG 18 release notes draft committed
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox