Re: Adjust the description of OutputPluginCallbacks in pg-doc

Amit Kapila <amit.kapila16@gmail.com>

From: Amit Kapila <amit.kapila16@gmail.com>
To: "wangw.fnst@fujitsu.com" <wangw.fnst@fujitsu.com>
Cc: "pgsql-hackers@lists.postgresql.org" <pgsql-hackers@lists.postgresql.org>
Date: 2023-01-19T11:19:52Z
Lists: pgsql-hackers
On Thu, Jan 19, 2023 at 4:47 PM Amit Kapila <amit.kapila16@gmail.com> wrote:
>
> On Wed, Jan 11, 2023 at 4:20 PM wangw.fnst@fujitsu.com
> <wangw.fnst@fujitsu.com> wrote:
> >
> > When I was reading the "Logical Decoding Output Plugins" chapter in pg-doc [1],
> > I think in the summary section, only the callback message_cb is not described
> > whether it is required or optional, and the description of callback
> > stream_prepare_cb seems inaccurate.
> >
> > And after the summary section, I think only the callback stream_xxx_cb section
> > and the callback truncate_cb section are not described this tag (are they
> > required or optional).
> >
> > I think we could improve these to be more reader friendly. So I tried to write
> > a patch for these and attach it.
> >
> > Any thoughts?
> >
>
> This looks mostly good to me. I have made minor adjustments in the
> attached. Do those make sense to you?
>

I forgot to mention that I intend to commit this only on HEAD as this
is a doc improvement patch.

-- 
With Regards,
Amit Kapila.



Commits

  1. Improve the description of Output Plugin Callbacks.