From: | Peter Smith <smithpb2250(at)gmail(dot)com> |
---|---|
To: | PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org> |
Subject: | DOCS: Avoid using abbreviation "aka" |
Date: | 2024-02-29 05:51:50 |
Message-ID: | CAHut+Ps01fV9bjhj6njCFiHu0W0gu1Jcu0tKo0RYMhHx-hZZ7g@mail.gmail.com |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-hackers |
While checking some recently pushed changes [1] I noticed
documentation [2] that includes the abbreviation "aka".
IMO it is preferable to avoid informal abbreviations like "aka" in the
documents, because not everyone will understand the meaning.
Furthermore, I think this is reinforced by the fact this was the
*only* example of "aka" that I could find in all of the .sgml. Indeed,
assuming that "aka" is short for "also known as" then the sentence
still doesn't seem correct even after those words are substituted.
HEAD
For the synchronization to work, it is mandatory to have a physical
replication slot between the primary and the standby aka
primary_slot_name should be configured on the standby, and
hot_standby_feedback must be enabled on the standby.
SUGGESTION
For the synchronization to work, it is mandatory to have a physical
replication slot between the primary and the standby (i.e.,
primary_slot_name should be configured on the standby), and
hot_standby_feedback must be enabled on the standby.
~
I found that the "aka" was introduced in v86-0001 [3]. So my
replacement text above restores to something similar to how it was in
v85-0001.
PSA a patch for the same.
----------
[1] https://github.com/postgres/postgres/commit/ddd5f4f54a026db6a6692876d0d44aef902ab686#diff-29c2d2e0480177b04f9c3d82c1454f8c00a11b8e761a9c9f5f4f6d61e6f19252
[2] https://www.postgresql.org/docs/devel/logicaldecoding-explanation.html#LOGICALDECODING-REPLICATION-SLOTS-SYNCHRONIZATION
[3] [1] https://www.postgresql.org/message-id/OS0PR01MB5716E581B4227DDEB4DE6C30944F2%40OS0PR01MB5716.jpnprd01.prod.outlook.com
Kind Regards,
Peter Smith.
Fujitsu Australia
Attachment | Content-Type | Size |
---|---|---|
v1-0001-Replace-aka-in-docs.patch | application/octet-stream | 1.3 KB |
From | Date | Subject | |
---|---|---|---|
Next Message | Michael Paquier | 2024-02-29 05:54:39 | Re: Injection points: some tools to wait and wake |
Previous Message | Tender Wang | 2024-02-29 05:25:20 | Re: "type with xxxx does not exist" when doing ExecMemoize() |