Re: [PATCH] Fix a tiny typo in the documentation - Mailing list pgsql-hackers

From Tom Lane
Subject Re: [PATCH] Fix a tiny typo in the documentation
Date
Msg-id 3691388.1737560056@sss.pgh.pa.us
Whole thread Raw
In response to Re: [PATCH] Fix a tiny typo in the documentation  ("David G. Johnston" <david.g.johnston@gmail.com>)
Responses Re: [PATCH] Fix a tiny typo in the documentation
List pgsql-hackers
"David G. Johnston" <david.g.johnston@gmail.com> writes:
> On Wednesday, January 22, 2025, Daniel Gustafsson <daniel@yesql.se> wrote:
>> On 22 Jan 2025, at 11:23, Daniel Gustafsson <daniel@yesql.se> wrote:
>>> On 22 Jan 2025, at 09:27, Robin Dupret <robin.dupret@gmail.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



pgsql-hackers by date:

Previous
From: Dagfinn Ilmari Mannsåker
Date:
Subject: Re: pg_createsubscriber TAP test wrapping makes command options hard to read.
Next
From: Nathan Bossart
Date:
Subject: Re: Pre-allocating WAL files