Re: PGdoc: add missing ID attribute to create_subscription.sgml

From: Peter Smith <smithpb2250(at)gmail(dot)com>
To: "Hayato Kuroda (Fujitsu)" <kuroda(dot)hayato(at)fujitsu(dot)com>
Cc: pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>, Amit Kapila <amit(dot)kapila16(at)gmail(dot)com>, "shiy(dot)fnst(at)fujitsu(dot)com" <shiy(dot)fnst(at)fujitsu(dot)com>, Melih Mutlu <m(dot)melihmutlu(at)gmail(dot)com>, vignesh C <vignesh21(at)gmail(dot)com>, Euler Taveira <euler(at)eulerto(dot)com>, Bharath Rupireddy <bharath(dot)rupireddyforpostgres(at)gmail(dot)com>, "Takamichi Osumi (Fujitsu)" <osumi(dot)takamichi(at)fujitsu(dot)com>
Subject: Re: PGdoc: add missing ID attribute to create_subscription.sgml
Date: 2023-03-27 06:56:53
Message-ID: CAHut+PuzNDbkSdX97fJWhMuH2SR0Gfub2wzPp48nMxL7TMpKmg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Here are review comments for v2-0001

======
Commit Message

1.
In commit ecb696, an XML ID attribute was added to only one varlistentry,
creating inconsistency with the commit 78ee60. This commit adds XML ID
attributes to all varlistentries in create_subscritpion.sgml for consistency.
Additionally, links are added to refer subscription options, enhancing the
readability of documents.

~

1a.
Typo: create_subscritpion.sgml

~

1b.
"to refer subscription options" --> "to refer to the subscription options"

======
doc/src/sgml/config.sgml

2.
- <literal>streaming</literal> option (see optional parameters set by
- <link linkend="sql-createsubscription"><command>CREATE
SUBSCRIPTION</command></link>)
+ <link linkend="sql-createsubscription-with-streaming"><literal>streaming</literal></link>
+ parameter of <link
linkend="sql-createsubscription"><command>CREATE
SUBSCRIPTION</command></link>

Now, this link says "streaming parameter", but the very next paragraph
refers to "streaming option". I think it is better to keep them the
same (e.g. both say "streaming option").

======
doc/src/sgml/ref/alter_subscription.sgml

The SKIP part says "... enabling two_phase on subscriber.". I thought
there could be a link for "two_phase" here (also "on subscriber" -->
"on the subscriber").

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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Smith 2023-03-27 06:58:25 Re: PGdoc: add missing ID attribute to create_subscription.sgml
Previous Message Drouvot, Bertrand 2023-03-27 06:54:13 Re: Generate pg_stat_get_xact*() functions with Macros