Re: Very misleading documentation for PQreset() - Mailing list pgsql-hackers

From Noah Misch
Subject Re: Very misleading documentation for PQreset()
Date
Msg-id 20210122063203.GA2108099@rfd.leadboat.com
Whole thread Raw
In response to Very misleading documentation for PQreset()  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-hackers
On Thu, Jan 21, 2021 at 05:32:56PM -0500, Tom Lane wrote:
> I happened to notice that PQreset is documented thus:
> 
>     This function will close the connection to the server and attempt to
>     reestablish a new connection to the same server, using all the same
>     parameters previously used.
> 
> Since we invented multi-host connection parameters, a reasonable person
> would assume that "to the same server" means we promise to reconnect to
> the same host we selected the first time.  There is no such guarantee
> though; the new connection attempt is done just like the first one,
> so it will select the first suitable server in the list.
> 
> I think we should just drop that phrase.

I agree that dropping the phrase strictly improves that documentation.



pgsql-hackers by date:

Previous
From: Corey Huinker
Date:
Subject: Re: simplifying foreign key/RI checks
Next
From: Craig Ringer
Date:
Subject: Re: [PATCH] More docs on what to do and not do in extension code