Re: DOCS - inactive_since field readability

From: Peter Smith <smithpb2250(at)gmail(dot)com>
To: Amit Kapila <amit(dot)kapila16(at)gmail(dot)com>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: DOCS - inactive_since field readability
Date: 2025-02-13 22:33:35
Message-ID: CAHut+Pt-LumoQF2UZfyWurXfF1ypwYUxv=o7_azV4LEQUZyN7g@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Tue, Feb 11, 2025 at 10:10 PM Amit Kapila <amit(dot)kapila16(at)gmail(dot)com> wrote:
>
...
> The change in 0001 looks odd after seeing it in HTML format. We should
> either add one empty line between two paragraphs otherwise it doesn't
> appear good. Did you see multi-paragraphs in any other column
> definitions?
>
> For the 0002 patch, I find the following changes as improvements,
> *
> <para>
> - Note that for slots on the standby
> to
> + For standby slots
>
> *
> On standby, this is useful for slots
> - that are being synced from a primary server (whose
> - <structfield>synced</structfield> field is <literal>true</literal>)
> - so they know when the slot stopped being synchronized.
> to
> This helps standby slots
> + track when synchronization was interrupted.
>
> Other than that, I find the current wording okay.
>

Hi Amit, thanks for the feedback!

//////

Patch 0001

The pg_replication_slots system view is unusual in that there can be
entirely different descriptions of the same field depending on the
context, such as:
a- for logical slots
b- for physical slots
c- for primary servers versus standby servers

IIUC your 0001 feedback says that a blank line might be ok, but just
doing it for 'active_since' and nothing else makes it look odd. So, I
have modified the 0001 patch to add blank lines separating those
different contexts (e.g. a,b,c) for all fields. I think it improves
the readability.

In passing.
- changed null to <literal>NULL</literal>
- changed true to <literal>true</literal>
- changed false to <literal>false</literal>

//////

Patch 0002

Modified the text as suggested.

======
Kind Regards,
Peter Smith.
Fujitsu Australia

Attachment Content-Type Size
v2-0001-DOCS-pg_replication_slots.-Add-blank-lines.patch application/octet-stream 6.8 KB
v2-0002-DOCS-pg_replication_slots.-Improve-the-active_sin.patch application/octet-stream 1.6 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Nathan Bossart 2025-02-13 22:36:58 Re: pg17.3 PQescapeIdentifier() ignores len
Previous Message Nathan Bossart 2025-02-13 22:32:10 Re: Remove a unnecessary argument from execute_extension_script()