From: | Fujii Masao <masao(dot)fujii(at)oss(dot)nttdata(dot)com> |
---|---|
To: | Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> |
Cc: | pgsql-docs(at)lists(dot)postgresql(dot)org |
Subject: | Re: descriptions of pg_stat_user_functions and pg_stat_slru |
Date: | 2020-05-20 05:44:46 |
Message-ID: | f31875d6-2300-87af-1479-c9d9abc013be@oss.nttdata.com |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-docs |
On 2020/05/20 11:05, Tom Lane wrote:
> Fujii Masao <masao(dot)fujii(at)oss(dot)nttdata(dot)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
From | Date | Subject | |
---|---|---|---|
Next Message | Marina Polyakova | 2020-05-20 09:01:20 | Re: Missing comma? |
Previous Message | Michael Paquier | 2020-05-20 05:26:36 | Re: Missing comma? |