Re: Documentation improvement patch - Mailing list pgsql-docs

From Peter Eisentraut
Subject Re: Documentation improvement patch
Date
Msg-id 6de77026-b34f-4f32-a0f3-2dc345c4b1bf@eisentraut.org
Whole thread Raw
In response to Re: Documentation improvement patch  (Oleg <o.sibiryakov@postgrespro.ru>)
List pgsql-docs
On 25.10.25 21:01, Oleg wrote:
> Dear Daniel,
> 
> Thank you for your prompt feedback.
> 
> Attached, please find the updated documentation patch, which 
> incorporates your suggestions from both the first and second rounds of 
> review.

       <term><literal>ALTER_REPLICATION_SLOT</literal> <replaceable 
class="parameter">slot_name</replaceable> ( <replaceable 
class="parameter">option</replaceable> [, ...] )
        <indexterm><primary>ALTER_REPLICATION_SLOT</primary></indexterm>
       </term>
       <listitem>
        <para>
-       Change the definition of a replication slot.
+       Changes the definition of a replication slot.

I think these are intentionally written in imperative style.  Compare 
the synopses of the main SQL commands: "change the definition of a 
domain" etc.

-     First, define a <literal>PgStat_KindInfo</literal> that includes all
+     First, define <literal>PgStat_KindInfo</literal> that includes all

I think this change is incorrect.  You are being asked to define an 
instance of PgStat_KindInfo, not PgStat_KindInfo itself (which already 
exists).

The remaining changes look ok to me.




pgsql-docs by date:

Previous
From: Peter Eisentraut
Date:
Subject: Re: docs: Link to the correct protocol version inspection function
Next
From: PG Doc comments form
Date:
Subject: Implicit type conversion for json/jsonb