Re: Documentation improvement patch

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Oleg <o(dot)sibiryakov(at)postgrespro(dot)ru>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Documentation improvement patch
Date: 2025-10-10 07:15:51
Message-ID: 3881A97B-0146-4389-9C39-3C596536750B@yesql.se
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 10 Sep 2025, at 09:54, Oleg <o(dot)sibiryakov(at)postgrespro(dot)ru> wrote:
>
> Dear all,
> I have prepared a patch containing some minor inconsistencies in the documentation. Please, take a look.
> I will be looking forward to your feedback.

Thanks for the patch, while most of these are obvious improvements I have a few
comments on some:

- Change the definition of a replication slot.
+ Changes the definition of a replication slot.
Reading this page it seems we are mixing tense in many places, some say "Change
the" and "Read some" and elsewhere we use "Drops the". Maybe a more holistic
approach would be better for this page to improve consistency?

- Not enabled by default because it is resource intensive.
+ Not enabled by default because it is resource-intensive.
We use both spellings in multiple places, shouldn't all be changed?

- <command>COPY</command> and other file-access functions.
+ the <command>COPY</command> command and file-access functions.
...
- <command>COPY</command> and other file-access functions.
+ the <command>COPY</command> command and file-access functions.
...
- <command>COPY</command> and other functions which allow executing a
+ the <command>COPY</command> command and functions, which allow executing a
I'm not sure about these, I think we use COPY without the the "the COPY
command" decoration in many places so I think it's more consistent like this.

- to call functions defined in the standard internal library, by using an
+ to call functions defined in the standard internal function library by using an
interface similar to their SQL signature.
Isn't it a bit redundant to say "internal function library" when we are already
talking about function definitions?

> The patch shall be applied to the REL_18_STABLE branch.

As you mentioned downthread, this is also for master. Our workflow is to
always apply to master and backpatch from there.

--
Daniel Gustafsson

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Jelte Fennema-Nio 2025-10-13 09:57:06 Re: CancelRequest(F) documentation.
Previous Message Oleg 2025-10-10 06:38:14 Re: Documentation improvement patch