Improve PQauthDataHook_type docs

Started by Daniele Varrazzo10 days ago1 messagesdocs
Jump to latest
#1Daniele Varrazzo
daniele.varrazzo@gmail.com

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

Attachments:

0001-doc-improve-PQauthDataHook_type-definition.patchtext/x-patch; charset=US-ASCII; name=0001-doc-improve-PQauthDataHook_type-definition.patchDownload+1-2