From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: descriptions of pg_stat_user_functions and pg_stat_slru
Date: Wed, 20 May 2020 14:44:46 +0900
Message-ID: <f31875d6-2300-87af-1479-c9d9abc013be@oss.nttdata.com> (raw)
In-Reply-To: <23668.1589940341@sss.pgh.pa.us>
References: <6f8a482c-b3fa-4ed9-21c3-6d222a2cb87d@oss.nttdata.com>
<23668.1589940341@sss.pgh.pa.us>
On 2020/05/20 11:05, Tom Lane wrote:
> 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.
Yeah, I agree to change the layout that way.
Also I don't like that all the stats views are packed in one section
currently. Which makes the docs difficult to read, I'm afraid. Thought?
If we change the layout entirely, at the same time, what about separating
each view into different section by adding <sect2>?
Regards,
--
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
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: masao.fujii@oss.nttdata.com, tgl@sss.pgh.pa.us, pgsql-docs@lists.postgresql.org
Subject: Re: descriptions of pg_stat_user_functions and pg_stat_slru
In-Reply-To: <f31875d6-2300-87af-1479-c9d9abc013be@oss.nttdata.com>
* 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