Re: Enhance create subscription reference manual

From: Tatsuo Ishii <ishii(at)postgresql(dot)org>
To: nagata(at)sraoss(dot)co(dot)jp
Cc: pgsql-hackers(at)postgresql(dot)org
Subject: Re: Enhance create subscription reference manual
Date: 2024-10-02 05:52:58
Message-ID: 20241002.145258.994404457924792338.ishii@postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

>> Currently the manual explains create subscription's "failover"
>> parameter as follows:
>>
>> <para>
>> Since no connection is made when this option is
>> <literal>false</literal>, no tables are subscribed. To initiate
>> replication, you must manually create the replication slot, enable
>> the failover if required, enable the subscription, and refresh the
>> subscription. See
>> <xref linkend="logical-replication-subscription-examples-deferred-slot"/>
>> for examples.
>> </para>
>>
>> While translating it into Japanese, we were little confused what "the
>> failover" actually means because we thought it might refer to the
>> failover operation or the failover parameter in the command. After a
>> discussion in the translation team, we concluded that it must refer to
>> the failover parameter. If we were correct, it would be nice to add
>> <literal> tag to "failover" to make it clear that it refers to a
>> failover parameter. Attached is the patch to do that.
>
> I agreed with adding <literal> tag to "failover" since it is done in the
> description on "slot_name" parameter.
>
> How about also rewrite it to "enable the failover option" rather than simply
> "enable the failover" to clarify that the parameter is refereed to.
>
> We could also use "enable the failover parameter". I think both make sense, but
> it seems that "failover option" is preferred in the slot_name description.

But a few lines above we have:

<para>
This clause specifies optional parameters for a subscription.
</para>

<para>
The following parameters control what happens during subscription creation:

So it seems "paramter" is more consistent than "option" here.

Best reagards,
--
Tatsuo Ishii
SRA OSS K.K.
English: http://www.sraoss.co.jp/index_en/
Japanese:http://www.sraoss.co.jp

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Hayato Kuroda (Fujitsu) 2024-10-02 06:33:50 RE: Conflict detection for update_deleted in logical replication
Previous Message Michael Paquier 2024-10-02 05:28:44 Re: Sequence Access Methods, round two