pgsql: doc: Fix misleading synopsis for CREATE/ALTER PUBLICATION. - Mailing list pgsql-committers

From Fujii Masao
Subject pgsql: doc: Fix misleading synopsis for CREATE/ALTER PUBLICATION.
Date
Msg-id E1vOd3X-001fbQ-1i@gemulon.postgresql.org
Whole thread Raw
List pgsql-committers
doc: Fix misleading synopsis for CREATE/ALTER PUBLICATION.

The documentation for CREATE/ALTER PUBLICATION previously showed:

        [ ONLY ] table_name [ * ] [ ( column_name [, ... ] ) ] [ WHERE ( expression ) ] [, ... ]

to indicate that the table/column specification could be repeated.
However, placing [, ... ] directly after a multi-part construct was
misleading and made it unclear which portion was repeatable.

This commit introduces a new term, table_and_columns, to represent:

        [ ONLY ] table_name [ * ] [ ( column_name [, ... ] ) ] [ WHERE ( expression ) ]

and updates the synopsis to use:

        table_and_columns [, ... ]

which clearly identifies the repeatable element.

Backpatched to v15, where the misleading syntax was introduced.

Author: Peter Smith <smithpb2250@gmail.com>
Reviewed-by: Chao Li <lic@highgo.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CAHut+PtsyvYL3KmA6C8f0ZpXQ=7FEqQtETVy-BOF+cm9WPvfMQ@mail.gmail.com
Backpatch-through: 15

Branch
------
REL_16_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/fc6e1a0f2bad75bc021024c5a676576962222157

Modified Files
--------------
doc/src/sgml/ref/alter_publication.sgml  | 8 ++++++--
doc/src/sgml/ref/create_publication.sgml | 6 +++++-
2 files changed, 11 insertions(+), 3 deletions(-)


pgsql-committers by date:

Previous
From: Fujii Masao
Date:
Subject: pgsql: doc: Fix misleading synopsis for CREATE/ALTER PUBLICATION.
Next
From: Fujii Masao
Date:
Subject: pgsql: doc: Fix misleading synopsis for CREATE/ALTER PUBLICATION.