PostgreSQL 15 minor fixes in protocol.sgml

From: Ekaterina Kiryanova <e(dot)kiryanova(at)postgrespro(dot)ru>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: PostgreSQL 15 minor fixes in protocol.sgml
Date: 2022-08-01 20:00:20
Message-ID: 745414e7-efb2-a6ae-5b83-fcbdf35aabc8@postgrespro.ru
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

Hello!

I've come across some typos in protocol.sgml for PostgreSQL 15 so please
have a look at the attached patch.

I didn't include it in the patch but I also suggest removing single
quotes around 'method' for the COMPRESSION option to help avoid
confusion. (All the supported compression methods consist of a single
word so in my opinion there is no need to use quotes in this case.)
-- <term><literal>COMPRESSION</literal>
<replaceable>'method'</replaceable></term>

I've also noticed that there are two ways to describe an option: "If set
to true" / "If true". As far as I know, the option here is specified by
its name rather than being explicitly set to true so "if true" seems to
be more correct, and this could be a slight improvement for this page.
Please correct me if I'm wrong.

Another point worth mentioning is that only this file contains the
phrase "two-phase transaction". I believe that "two-phase commit
transaction" or "transaction prepared for two-phase commit" depending on
the situation would be better wording.

And finally, could you please clarify this part?
-- The end LSN of the prepare transaction.
Is it a typo of "prepared transaction"? Or is it the LSN of the
transaction for Prepare?
If it's the latter, perhaps it'd make more sense to capitalize it.

--
Best regards,
Ekaterina Kiryanova
Technical Writer
Postgres Professional
the Russian PostgreSQL Company

Attachment Content-Type Size
protocol.patch text/x-patch 11.8 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Michael Paquier 2022-08-02 10:58:10 Re: PostgreSQL 15 minor fixes in protocol.sgml
Previous Message PG Doc comments form 2022-07-31 23:37:03 Typo in "43.9.1. Reporting Errors and Messages"?

Browse pgsql-hackers by date

  From Date Subject
Next Message Robert Haas 2022-08-01 20:01:20 Re: [Commitfest 2022-07] Patch Triage: Waiting on Author
Previous Message Andrew Dunstan 2022-08-01 19:53:11 Re: [feature]COPY FROM enable FORCE_NULL/FORCE_NOT_NULL on all columns