Re: [PATCH] Fix a tiny typo in the documentation

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: Daniel Gustafsson <daniel(at)yesql(dot)se>, Robin Dupret <robin(dot)dupret(at)gmail(dot)com>, PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: [PATCH] Fix a tiny typo in the documentation
Date: 2025-01-22 15:34:16
Message-ID: 3691388.1737560056@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

"David G. Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com> writes:
> On Wednesday, January 22, 2025, Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
>> On 22 Jan 2025, at 11:23, Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
>>> On 22 Jan 2025, at 09:27, Robin Dupret <robin(dot)dupret(at)gmail(dot)com> wrote:
>>>> - special provision: you must write
>>>> + special provision you must write:

>> Re-reading it I think both placements of ':' are grammatically correct (not
>> being a native speaker might trick me).

> The colon does belong after provision, not write. If the colon is
> bothersome rewrite to avoid it altogether. But the status quo works for me.

I agree: removing the colon from where it is is strictly worse.
There should be some kind of pause or separation there.
Conceivably we could do

- special provision: you must write
+ special provision. You must write:

But like David, I don't feel a need to change anything here. There
are many places in our docs where we flow into a <programlisting> or
similar block without punctuation, and most of them read just fine
to me.

regards, tom lane

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Shlok Kyal 2025-01-22 15:41:55 Re: create subscription with (origin = none, copy_data = on)
Previous Message Dagfinn Ilmari Mannsåker 2025-01-22 15:34:11 Re: pg_createsubscriber TAP test wrapping makes command options hard to read.