CREATE PUBLICATION should "See Also" CREATE SUBSCRIPTION

Started by Peter Smithabout 4 years ago5 messages
#1Peter Smith
smithpb2250@gmail.com

Hi.

I noticed recently that the CREATE PUBLICATION docs page [1]https://www.postgresql.org/docs/devel/sql-createpublication.html does not
have any "See Also" reference to the CREATE SUBSCRIPTION docs page
[2]: https://www.postgresql.org/docs/devel/sql-createsubscription.html

Perhaps it is deliberate (??) but IMO it just seemed like a
strange/annoying omission that there was no easy way to jump both ways
between those two pages.

OTOH, the reverse is OK - the CREATE SUBSCRIPTION docs page *does*
have a "See Also" reference to CREATE PUBLICATION.

Here is a patch:

--- a/doc/src/sgml/ref/create_publication.sgml
+++ b/doc/src/sgml/ref/create_publication.sgml
@@ -333,6 +333,7 @@ CREATE PUBLICATION sales_publication FOR ALL
TABLES IN SCHEMA marketing, sales;
   <simplelist type="inline">
    <member><xref linkend="sql-alterpublication"/></member>
    <member><xref linkend="sql-droppublication"/></member>
+   <member><xref linkend="sql-createsubscription"/></member>
   </simplelist>
  </refsect1>
 </refentry>

------
[1]: https://www.postgresql.org/docs/devel/sql-createpublication.html
[2]: https://www.postgresql.org/docs/devel/sql-createsubscription.html

Kind Regards,
Peter Smith.
Fujitsu Australia

#2Daniel Gustafsson
daniel@yesql.se
In reply to: Peter Smith (#1)
Re: CREATE PUBLICATION should "See Also" CREATE SUBSCRIPTION

On 15 Nov 2021, at 23:29, Peter Smith <smithpb2250@gmail.com> wrote:

I noticed recently that the CREATE PUBLICATION docs page [1] does not
have any "See Also" reference to the CREATE SUBSCRIPTION docs page
[2].

Nice catch.

<simplelist type="inline">
<member><xref linkend="sql-alterpublication"/></member>
<member><xref linkend="sql-droppublication"/></member>
+ <member><xref linkend="sql-createsubscription"/></member>

To make it analogous with how CREATE/ALTER for SUBSCRIPTION and PUBLICATION
reference each other, there should IMO be another xref to ALTER SUBSCRIPTION as
well.

Unless there are objections, I'll apply that.

--
Daniel Gustafsson https://vmware.com/

#3Masahiko Sawada
sawada.mshk@gmail.com
In reply to: Daniel Gustafsson (#2)
Re: CREATE PUBLICATION should "See Also" CREATE SUBSCRIPTION

On Tue, Nov 16, 2021 at 10:21 PM Daniel Gustafsson <daniel@yesql.se> wrote:

On 15 Nov 2021, at 23:29, Peter Smith <smithpb2250@gmail.com> wrote:

I noticed recently that the CREATE PUBLICATION docs page [1] does not
have any "See Also" reference to the CREATE SUBSCRIPTION docs page
[2].

Nice catch.

<simplelist type="inline">
<member><xref linkend="sql-alterpublication"/></member>
<member><xref linkend="sql-droppublication"/></member>
+ <member><xref linkend="sql-createsubscription"/></member>

To make it analogous with how CREATE/ALTER for SUBSCRIPTION and PUBLICATION
reference each other, there should IMO be another xref to ALTER SUBSCRIPTION as
well.

+1

Regards,

--
Masahiko Sawada
EDB: https://www.enterprisedb.com/

#4Daniel Gustafsson
daniel@yesql.se
In reply to: Masahiko Sawada (#3)
Re: CREATE PUBLICATION should "See Also" CREATE SUBSCRIPTION

On 17 Nov 2021, at 09:24, Masahiko Sawada <sawada.mshk@gmail.com> wrote:
On Tue, Nov 16, 2021 at 10:21 PM Daniel Gustafsson <daniel@yesql.se> wrote:

On 15 Nov 2021, at 23:29, Peter Smith <smithpb2250@gmail.com> wrote:

<simplelist type="inline">
<member><xref linkend="sql-alterpublication"/></member>
<member><xref linkend="sql-droppublication"/></member>
+ <member><xref linkend="sql-createsubscription"/></member>

To make it analogous with how CREATE/ALTER for SUBSCRIPTION and PUBLICATION
reference each other, there should IMO be another xref to ALTER SUBSCRIPTION as
well.

+1

Pushed, thanks for review!

--
Daniel Gustafsson https://vmware.com/

#5Peter Smith
smithpb2250@gmail.com
In reply to: Daniel Gustafsson (#4)
Re: CREATE PUBLICATION should "See Also" CREATE SUBSCRIPTION

On Wed, Nov 17, 2021 at 11:45 PM Daniel Gustafsson <daniel@yesql.se> wrote:

Pushed, thanks for review!

Thanks!

------
Kind Regards,
Peter Smith.
Fujitsu Australia