Re: Documentation improvement patch - Mailing list pgsql-docs

From Peter Eisentraut
Subject Re: Documentation improvement patch
Date
Msg-id c2ca18b0-bf47-4566-a4e6-ef0fb676ac21@eisentraut.org
Whole thread Raw
In response to Re: Documentation improvement patch  (Daniel Gustafsson <daniel@yesql.se>)
Responses Re: Documentation improvement patch
List pgsql-docs
On 14.11.25 10:04, Daniel Gustafsson wrote:
>> On 30 Oct 2025, at 11:15, Peter Eisentraut <peter@eisentraut.org> wrote:
> 
>> -       Change the definition of a replication slot.
>> +       Changes the definition of a replication slot.
>>
>> I think these are intentionally written in imperative style.  Compare the synopses of the main SQL commands: "change
thedefinition of a domain" etc.
 
> 
> I agree, I too think these are intentionally written like this.  The document
> isn't entirely consistent and does mix style quite a bit but I don't think
> these changes change the needle enough to make.

The following changes are left in your patch that should not be changed 
per the above discussion (all in doc/src/sgml/protocol.sgml):

-       Create a physical or logical replication
+       Creates a physical or logical replication

-       Instructs server to start streaming WAL, starting at
+       Instructs the server to start streaming WAL, starting at

-       Instructs server to start streaming WAL for logical replication,
+       Instructs the server to start streaming WAL for logical replication,

Separately, maybe this could be improved further:

-        Sets the maximum number of open files each server subprocess is
+        Sets the maximum number of files each server subprocess is
          allowed to open simultaneously;  files already opened in the

I think it would be more correct to say something like "... number of 
files each server subprocess is allowed to have open simultaneously ..." 
(not how many open actions are happening concurrently).




pgsql-docs by date:

Previous
From: Laurenz Albe
Date:
Subject: Re: Ambiguity in IS JSON description and logic
Next
From: Daniel Gustafsson
Date:
Subject: Re: Documentation improvement patch