Re: Documentation improvement patch

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: Oleg <o(dot)sibiryakov(at)postgrespro(dot)ru>, Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Documentation improvement patch
Date: 2025-10-30 10:15:26
Message-ID: 6de77026-b34f-4f32-a0f3-2dc345c4b1bf@eisentraut.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: 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.

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2025-10-30 12:16:48 Implicit type conversion for json/jsonb
Previous Message Peter Eisentraut 2025-10-30 10:06:40 Re: docs: Link to the correct protocol version inspection function