Thread: doc: modify the comment in function libpqrcv_check_conninfo()

Hi,

The function 'libpqrcv_check_conninfo()' returns 'void', but the comment 
above says that the function returns true or false.
I've attached a patch to modify the comment.

Regard,
Rintaro Ikeda

On Wed, 26 Jun 2024 at 14:53, ikedarintarof
<ikedarintarof@oss.nttdata.com> wrote:
> The function 'libpqrcv_check_conninfo()' returns 'void', but the comment
> above says that the function returns true or false.
> I've attached a patch to modify the comment.

Agreed that the current comment is wrong, but the new comment should
mention the must_use_password argument. Because only if
must_use_password is true, will it throw an error.

Thank you for your comment!

I've added the must_use_password argument. A new patch is attached.


On 2024-06-26 23:36, Jelte Fennema-Nio wrote:
> On Wed, 26 Jun 2024 at 14:53, ikedarintarof
> <ikedarintarof@oss.nttdata.com> wrote:
>> The function 'libpqrcv_check_conninfo()' returns 'void', but the 
>> comment
>> above says that the function returns true or false.
>> I've attached a patch to modify the comment.
> 
> Agreed that the current comment is wrong, but the new comment should
> mention the must_use_password argument. Because only if
> must_use_password is true, will it throw an error.

On Thu, 27 Jun 2024 at 09:09, ikedarintarof
<ikedarintarof@oss.nttdata.com> wrote:
>
> Thank you for your comment!
>
> I've added the must_use_password argument. A new patch is attached.

s/whther/whether

nit: "it will do nothing" sounds a bit strange to me (but I'm not
native english). Something like this reads more natural to me:

an error. If must_use_password is true, the function raises an error
if no password is provided in the connection string. In any other case
it successfully completes.

Thanks for your suggestion. I used ChatGPT to choose the wording, but 
it's still difficult for me.

The new patch includes your suggestion.

On 2024-06-27 17:18, Jelte Fennema-Nio wrote:
> On Thu, 27 Jun 2024 at 09:09, ikedarintarof
> <ikedarintarof@oss.nttdata.com> wrote:
>> 
>> Thank you for your comment!
>> 
>> I've added the must_use_password argument. A new patch is attached.
> 
> s/whther/whether
> 
> nit: "it will do nothing" sounds a bit strange to me (but I'm not
> native english). Something like this reads more natural to me:
> 
> an error. If must_use_password is true, the function raises an error
> if no password is provided in the connection string. In any other case
> it successfully completes.