Re: Keyword docs missing, or mislabelled keywords

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: danny(dot)jones1994(at)live(dot)com, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Keyword docs missing, or mislabelled keywords
Date: 2021-09-02 19:32:52
Message-ID: 2266036.1630611172@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

"David G. Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com> writes:
> On Thu, Sep 2, 2021 at 7:11 AM PG Doc comments form <noreply(at)postgresql(dot)org>
> wrote:
>> Missing:
>> RESTRICTED (as found in CREATE FUNCTION (PARALLEL RESTRICTED))
>> SAFE (as found in CREATE FUNCTION (PARALLEL SAFE))
>> UNSAFE (as found in CREATE FUNCTION (PARALLEL UNSAFE))

> I'll agree that the documentation for this doesn't fully describe the
> intricacies of the implementation, but the listing, at least for the
> PARALLEL related options, is correct.

In recent versions that listing is guaranteed correct, because it's
generated mechanically from the same keyword list the grammar uses.

But, as you say, it's not the whole story because some commands have
options that are not keywords in the eyes of the grammar, just identifiers
that are looked up later. Indeed we encourage that where we can, to avoid
grammar bloat. Maybe it'd be appropriate to add some text here about
that? But I'm not sure where to stop, because there are lots of things
that are identifiers but an unsophisticated user might think are keywords.
(Index type names, for example.)

regards, tom lane

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2021-09-03 08:44:34 create rule
Previous Message David G. Johnston 2021-09-02 14:54:17 Re: Keyword docs missing, or mislabelled keywords