From: Tom Lane <tgl@sss.pgh.pa.us>
To: Fujii Masao <masao.fujii@oss.nttdata.com>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: descriptions of pg_stat_user_functions and pg_stat_slru
Date: Tue, 19 May 2020 22:05:41 -0400
Message-ID: <23668.1589940341@sss.pgh.pa.us> (raw)
In-Reply-To: <6f8a482c-b3fa-4ed9-21c3-6d222a2cb87d@oss.nttdata.com>
References: <6f8a482c-b3fa-4ed9-21c3-6d222a2cb87d@oss.nttdata.com>
Fujii Masao <masao.fujii@oss.nttdata.com> writes:
> In monitoring.sgml, there are the tables and corresponding descriptions
> for pg_stat_user_functions and pg_stat_slru views. I found that those
> descriptions are located in opposite places. For example, the description
> for pg_stat_user_functions wrongly comes just after the table for
> pg_stat_slru view. Attached patch fixes this issue.
Hm, I see your point, but I think there is a bigger problem here:
this entire section was written with great disregard for our normal
conventions of how to lay out text around tables. The standard thing,
as seen in Chapter 9 or the system catalog section, is that first
you have an introductory paragraph --- preferably containing an actual
link to the table --- then you have the table, and then if you feel a
need for any footnote-like comments on the table, you put those below it.
I seem to recall Peter E. explaining that this is important because some
presentations might put the table out-of-line entirely, so you should
have an <xref> to it.
What we've mostly got in 27.2 as it stands is that the explanations are
below the tables, which is just backwards. I think the discrepancy
you spotted is because I added some text about the pg_stat_slru view
and just automatically added it above the table, not noticing that that
wasn't what the surrounding stuff did.
regards, tom lane
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: pgsql-docs@postgresql.org
Cc: tgl@sss.pgh.pa.us, masao.fujii@oss.nttdata.com, pgsql-docs@lists.postgresql.org
Subject: Re: descriptions of pg_stat_user_functions and pg_stat_slru
In-Reply-To: <23668.1589940341@sss.pgh.pa.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox