Improve PQauthDataHook_type docs - Mailing list pgsql-docs

From Daniele Varrazzo
Subject Improve PQauthDataHook_type docs
Date
Msg-id CA+mi_8aEyKfLG3_+x7uU6HBYtOug3HYFRq1sz7JB7N89=EmKUA@mail.gmail.com
Whole thread
List pgsql-docs
Hello,

In https://www.postgresql.org/docs/18/libpq-oauth.html#LIBPQ-OAUTH-AUTHDATA-HOOKS
it is not entirely clear that `hook_fn` is the definition of the
`PQauthDataHook_type` used in the functions signature, because the
name is not used elsewhere. The function signatures refer to the
typedef but the typedef is not shown.

Using https://www.postgresql.org/docs/18/libpq-notice-processing.html#LIBPQ-NOTICE-PROCESSING
as a guideline I suggest to show the typedef of the callback rather
than the `hook_fn` example, so that the `PQauthDataHook_type` name can
be searched for.

Please check the patch attached.

Cheers

-- Daniele

Attachment

pgsql-docs by date:

Previous
From: "David G. Johnston"
Date:
Subject: Re: Temporary tables and Write-Ahead Log
Next
From: Fujii Masao
Date:
Subject: Two small doc fixes for config.sgml