Re: Documentation improvement patch

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Peter Eisentraut <peter(at)eisentraut(dot)org>
Cc: Oleg <o(dot)sibiryakov(at)postgrespro(dot)ru>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Documentation improvement patch
Date: 2025-11-14 09:04:03
Message-ID: 93538952-E9CC-492C-9BDD-9249AD4C6B91@yesql.se
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 30 Oct 2025, at 11:15, Peter Eisentraut <peter(at)eisentraut(dot)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 the definition 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.

Attached is a v3 with the remaining changes and a stab at commit message that I
think we should go ahead with.

--
Daniel Gustafsson

Attachment Content-Type Size
v3-0001-doc-Assorted-documentation-improvements.patch application/octet-stream 12.2 KB

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Álvaro Herrera 2025-11-14 11:05:23 Re: copy.sgml: add XML ID attributes to <varlistentry> tags.
Previous Message Bruce Momjian 2025-11-12 13:48:39 Re: Quoting of *_command arguments