Re: Documented parameter names differ from callable proargnames for several built-ins

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Matemática A3K <matematica(dot)a3k(at)gmail(dot)com>
Cc: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>, Mi cro <micro6947(at)gmail(dot)com>, pgsql-docs(at)postgresql(dot)org
Subject: Re: Documented parameter names differ from callable proargnames for several built-ins
Date: 2026-11-03 04:15:30
Message-ID: CAKFQuwbfgPBXcwzGwvea0gh2qQLu=mgV10h-sws4Wuc-k1Qoyw@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Mon, Nov 2, 2026 at 8:47 PM Matemática A3K <matematica(dot)a3k(at)gmail(dot)com>
wrote:

> To inspect if each function parameter is documented correctly for each
> function of each supported release seems like a gargantuan task to be
> done.
>

We're pretty good about sgml markup in this area, it doesn't seem that hard
to build a deterministic detection system if someone wants to try. I'd
make it require an installed instance and use the catalog as the
authoritative dataset.

> Perhaps a note in somewhere that says "named parameters in functions
> are supported but may not be up to date, using positional arguments is
> the recommended way for function calling"?
>
>
I don't think we actually recommend that. Telling people how to find the
names of function parameters should they wish to use them and the docs
aren't correct would be helpful though. For procedure-like
functions/procedures I'd say named arguments are recommended.

David J.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Matemática A3K 2026-11-03 04:46:34 Re: Documented parameter names differ from callable proargnames for several built-ins
Previous Message Matemática A3K 2026-11-03 03:46:44 Re: Documented parameter names differ from callable proargnames for several built-ins