Thread: Adjust the description of OutputPluginCallbacks in pg-doc
Hi, 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? Regards, Wang Wei [1] - https://www.postgresql.org/docs/devel/logicaldecoding-output-plugin.html
Attachment
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? -- With Regards, Amit Kapila.
Attachment
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.
On Thurs, Jan 19, 2023 at 19:18 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? Thanks for your improvement. It makes sense to me. Regards, Wang Wei
On Fri, Jan 20, 2023 at 8:03 AM wangw.fnst@fujitsu.com <wangw.fnst@fujitsu.com> wrote: > > On Thurs, Jan 19, 2023 at 19:18 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? > > Thanks for your improvement. > It makes sense to me. > Pushed. -- With Regards, Amit Kapila.