Re: Get rid of "Section.N.N.N" on DOCs

From: Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>
To: Marcos Pegoraro <marcos(at)f10(dot)com(dot)br>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Get rid of "Section.N.N.N" on DOCs
Date: 2025-12-15 12:19:10
Message-ID: 5f5b4a5f08def3e175c75eb124adf17dcb9b2515.camel@cybertec.at
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: 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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Sonya Valchuk 2025-12-15 12:48:44 Reuse data from readRecordBuf in XLogDecodeNextRecord
Previous Message Marcos Pegoraro 2025-12-15 12:12:57 Re: Get rid of "Section.N.N.N" on DOCs