Re: Should we put command options in alphabetical order in the doc?

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Melanie Plageman <melanieplageman(at)gmail(dot)com>
Cc: Peter Geoghegan <pg(at)bowt(dot)ie>, Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>, David Rowley <dgrowleyml(at)gmail(dot)com>, PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Should we put command options in alphabetical order in the doc?
Date: 2023-04-19 21:45:41
Message-ID: 3024596.1681940741@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Melanie Plageman <melanieplageman(at)gmail(dot)com> writes:
> I do think we should consider deprecating and dropping documentation of
> the options that are supported without parentheses (relevant to commands
> like ANALYZE, CLUSTER, VACUUM, and others). It is fine if we keep the
> code to make ANALYZE VERBOSE work, but I don't think it is useful to
> keep that documented. That is not a concern of this patch, however.

I doubt it's a great idea to de-document syntax that's still allowed
and will still be widely used for years to come; that just promotes
confusion. However, we could do something similar to what we did
for COPY years ago, and move the un-parenthesized syntax to the
"Compatibility" section.

regards, tom lane

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message David Rowley 2023-04-19 22:37:49 Re: Incremental sort for access method with ordered scan support (amcanorderbyop)
Previous Message Aleksander Alekseev 2023-04-19 21:44:21 Re: [PATCH] Allow Postgres to pick an unused port to listen