Re: Minor Improvements to pg_buffercache documentation - Mailing list pgsql-docs

From Fujii Masao
Subject Re: Minor Improvements to pg_buffercache documentation
Date
Msg-id CAHGQGwEjrM1LqpWsJqJ8XKTQsGGee78i_2kirdzmFtG77dJ29w@mail.gmail.com
Whole thread Raw
In response to Re: Minor Improvements to pg_buffercache documentation  (Michael Paquier <michael@paquier.xyz>)
List pgsql-docs
On Tue, Jul 22, 2025 at 2:10 PM Michael Paquier <michael@paquier.xyz> wrote:
>
> On Thu, Jul 03, 2025 at 01:30:13AM +0900, Fujii Masao wrote:
> > BTW, all current index entries point to the top of the pg_buffercache
> > docs. Would it be better if each entry pointed directly to its relevant
> > section using a zone attribute like this?
> >
> > - <indexterm>
> > + <indexterm zone="pgbuffercache-summary">
> >    <primary>pg_buffercache_summary</primary>
> >   </indexterm>
>
> That would be smarter than the current statu-quo of the page,
> especially if this page grows more in size in the future.

The summary descriptions for each function and view are currently
at the top of the docs. If we update the index entries to point directly
to the relevant sections instead of the top, it might also make sense
to move those summaries into their respective sections.
I’ll consider this later.


> The other inconsistencies are good catches, by the way!

Thanks for the review! I've pushed the patch.

Regards,

--
Fujii Masao



pgsql-docs by date:

Previous
From: PG Doc comments form
Date:
Subject: Clarification on the column order of UNION, INTERSECT, and EXCEPT
Next
From: "David G. Johnston"
Date:
Subject: Re: Clarification on the column order of UNION, INTERSECT, and EXCEPT