Re: Mismatch for connection key/value pair between documentation and code?

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: "joe(dot)zhou(at)dualhelios(dot)com" <joe(dot)zhou(at)dualhelios(dot)com>, "pgsql-docs(at)lists(dot)postgresql(dot)org" <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Mismatch for connection key/value pair between documentation and code?
Date: 2024-07-16 14:20:19
Message-ID: CAKFQuwb7ScOPsFqV281m2SBumso7oYN+HWFKDeFrGMLQZA9FRg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Monday, July 15, 2024, PG Doc comments form <noreply(at)postgresql(dot)org>
wrote:

> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/16/libpq-connect.html
> Description:
>
>
> For the following document regarding connect string, it is not aligned with
> the code.
> https://www.postgresql.org/docs/current/libpq-connect.
> html#LIBPQ-CONNSTRING
>
> e.g. Timeout for connection
>
> "connect_timeout
> Maximum time to wait while connecting, in seconds (write as a decimal
> integer, e.g., 10).

> However in the code:
> https://github.com/npgsql/npgsql/blob/docs/src/Npgsql/
> NpgsqlConnectionStringBuilder.cs,
> starting L789 to L812 (latest version when I raise this ticket).

>
> The name is Timeout instead of connect_timeout, and there's no logic
> regarding 2 second check
>
>
Probably this third-party module is not using the libpq API. Or at minimum
not that aspect of the API.

David J.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Laurenz Albe 2024-07-16 15:20:56 Re: 13.2.1. Read Committed Isolation Level
Previous Message David G. Johnston 2024-07-16 14:13:49 Re: 13.2.2. Repeatable Read Isolation Level #