Обсуждение: Typo/wording on https://www.postgresql.org/docs/current/catalog-pg-class.html

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/catalog-pg-class.html
Description:

I've just read this:

"catalogs tables and most everything else that has columns or is otherwise
similar to a table"

It seems that it should be:

"catalogs tables and almost everything else that has columns or is otherwise
similar to a table"

So, "most" becomes "almost".

Clicking back through versions it changed from "mostly" to "most" at version
7.3.

Martin

> On 20 Sep 2023, at 07:23, PG Doc comments form <noreply@postgresql.org> wrote:
>
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/16/catalog-pg-class.html
> Description:
>
> I've just read this:
>
> "catalogs tables and most everything else that has columns or is otherwise
> similar to a table"
>
> It seems that it should be:
>
> "catalogs tables and almost everything else that has columns or is otherwise
> similar to a table"
>
> So, "most" becomes "almost".

While I'm not a native english speaker I do believe this wording is correct
(although I guess your version would be semantically the same or very close to
it).  It was done in commit 83501ef4ca some 20+ years ago.

--
Daniel Gustafsson

Daniel Gustafsson <daniel@yesql.se> writes:
>> On 20 Sep 2023, at 07:23, PG Doc comments form <noreply@postgresql.org> wrote:
>> I've just read this:
>> "catalogs tables and most everything else that has columns or is otherwise
>> similar to a table"
>> It seems that it should be:
>> "catalogs tables and almost everything else that has columns or is otherwise
>> similar to a table"

> While I'm not a native english speaker I do believe this wording is correct
> (although I guess your version would be semantically the same or very close to
> it).  It was done in commit 83501ef4ca some 20+ years ago.

"Most" here is good English, although I concede it's a slightly
old-fashioned usage.  Maybe it'd be clearer to just remove the
word altogether.

If we were going to touch this sentence I'd worry about some other
things too.  Use of "catalogs" as a verb is probably not the greatest
choice right here, since one could easily think that the verb is
missing and what was meant was "pg_class lists catalogs, [user]
tables, and ...".  Also, I think that the reference to special
relations is obsolete --- we don't list any relkind for that anymore.
What probably does deserve to be called out in place of those is
composite types, since their appearance in pg_class might be pretty
surprising to newbies.

            regards, tom lane

I wrote:
> "Most" here is good English, although I concede it's a slightly
> old-fashioned usage.  Maybe it'd be clearer to just remove the
> word altogether.

> If we were going to touch this sentence I'd worry about some other
> things too.  Use of "catalogs" as a verb is probably not the greatest
> choice right here, since one could easily think that the verb is
> missing and what was meant was "pg_class lists catalogs, [user]
> tables, and ...".  Also, I think that the reference to special
> relations is obsolete --- we don't list any relkind for that anymore.
> What probably does deserve to be called out in place of those is
> composite types, since their appearance in pg_class might be pretty
> surprising to newbies.

Hmm, I must have been looking at some old version of the docs, because
when I went to prepare a draft patch I found that those last couple of
points were addressed some time ago.  I think we just need some slightly
better wording here rather than any change of technical content.
I propose the attached.  (I also modified the para's last sentence to
speak of "kind" not "type", for consistency with the relkind field name
and the rest of the para.)

            regards, tom lane

diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index d17ff51e28..e09adb45e4 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -1893,8 +1893,8 @@ SCRAM-SHA-256$<replaceable><iteration count></replaceable>:<replaceable>&l
   </indexterm>

   <para>
-   The catalog <structname>pg_class</structname> catalogs tables and most
-   everything else that has columns or is otherwise similar to a
+   The catalog <structname>pg_class</structname> describes tables and
+   other objects that have columns or are otherwise similar to a
    table.  This includes indexes (but see also <link
    linkend="catalog-pg-index"><structname>pg_index</structname></link>),
    sequences (but see also <link
@@ -1902,8 +1902,8 @@ SCRAM-SHA-256$<replaceable><iteration count></replaceable>:<replaceable>&l
    views, materialized views, composite types, and TOAST tables;
    see <structfield>relkind</structfield>.
    Below, when we mean all of these kinds of objects we speak of
-   <quote>relations</quote>.  Not all columns are meaningful for all relation
-   types.
+   <quote>relations</quote>.  Not all of <structname>pg_class</structname>'s
+   columns are meaningful for all relation kinds.
   </para>

   <table>

> On 22 Sep 2023, at 19:04, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> 
> I wrote:
>> "Most" here is good English, although I concede it's a slightly
>> old-fashioned usage.  Maybe it'd be clearer to just remove the
>> word altogether.
> 
>> If we were going to touch this sentence I'd worry about some other
>> things too.  Use of "catalogs" as a verb is probably not the greatest
>> choice right here, since one could easily think that the verb is
>> missing and what was meant was "pg_class lists catalogs, [user]
>> tables, and ...".  Also, I think that the reference to special
>> relations is obsolete --- we don't list any relkind for that anymore.
>> What probably does deserve to be called out in place of those is
>> composite types, since their appearance in pg_class might be pretty
>> surprising to newbies.
> 
> Hmm, I must have been looking at some old version of the docs, because
> when I went to prepare a draft patch I found that those last couple of
> points were addressed some time ago.  I think we just need some slightly
> better wording here rather than any change of technical content.
> I propose the attached.  (I also modified the para's last sentence to
> speak of "kind" not "type", for consistency with the relkind field name
> and the rest of the para.)

LGTM.

--
Daniel Gustafsson

Daniel Gustafsson <daniel@yesql.se> writes:
>> On 22 Sep 2023, at 19:04, Tom Lane <tgl@sss.pgh.pa.us> wrote:
>> I propose the attached.  (I also modified the para's last sentence to
>> speak of "kind" not "type", for consistency with the relkind field name
>> and the rest of the para.)

> LGTM.

Pushed, thanks for looking.

            regards, tom lane