Re: Get rid of "Section.N.N.N" on DOCs - Mailing list pgsql-hackers

From Laurenz Albe
Subject Re: Get rid of "Section.N.N.N" on DOCs
Date
Msg-id 5f5b4a5f08def3e175c75eb124adf17dcb9b2515.camel@cybertec.at
Whole thread Raw
In response to Re: Get rid of "Section.N.N.N" on DOCs  (Marcos Pegoraro <marcos@f10.com.br>)
List pgsql-hackers
On Mon, 2025-12-15 at 09:12 -0300, Marcos Pegoraro wrote:
> But we can start by changing the ones we're sure of. If I haven't miscounted,
> there are about 1,500 places in the documentation where a Section n.n.n exists,
> but changing one source will correct 20 or 50 links of it. I'll change a few
> and see how it goes.

Right.  But you'd have to look at all the places with a reference and check
if the rendered text still makes sense, and if the change is actually an
improvement.

If we don't perceive the change as an improvement, you will meet resistance.
Apart from the effort of the change, there is also the increased effort of
backpatching documentation changes, and those efforts have to be outbalanced
by the benefits.

Yours,
Laurenz Albe



pgsql-hackers by date:

Previous
From: Marcos Pegoraro
Date:
Subject: Re: Get rid of "Section.N.N.N" on DOCs
Next
From: Sonya Valchuk
Date:
Subject: Reuse data from readRecordBuf in XLogDecodeNextRecord