From: Tomisław Kityński <t.kitynski@gmail.com>
To: Bruce Momjian <bruce@momjian.us>
To: pgsql-docs@lists.postgresql.org
Subject: Re: Suggestion for deprecated spellings
Date: Mon, 30 Jan 2023 21:52:15 +0100
Message-ID: <d0f46297-56e6-cf73-8b59-a7b23d675670@gmail.com> (raw)
In-Reply-To: <Y9grBFU+2DBXBB7z@momjian.us>
References: <167473556945.2667294.2003897901995802549@wrigleys.postgresql.org>
<Y9grBFU+2DBXBB7z@momjian.us>
W dniu 30.01.2023 o 21:39, Bruce Momjian pisze:
> On Thu, Jan 26, 2023 at 12:19:29PM +0000, PG Doc comments form wrote:
>> The following documentation comment has been logged on the website:
>>
>> Page:https://www.postgresql.org/docs/12/sql-createrole.html
>> Description:
>>
>> From time to time some spelling for given command gets obsolete, yet it is
>> shown in the syntax on "equal rights" as other valid clauses. For instance
>> see `CREATE ROLE` with deprecated spellings like `IN GROUP` or `USER`. I
>> guess it would be useful to see those spellings visually marked as
>> deprecated in Synopsis section (with e.g. strike-through or whatever suits
>> better). Otherwise, when consulting documentation, it often requires jumping
>> from the synopsis to detailed description and back to check if given
>> spelling is still applicable. Just a thought. :-)
> We don't need to show all _supported_ syntaxes in the "Synopsis"
> section, so we could just remove them.
>
I like this idea even more! :-) Much cleaner approach . And then those
obsolete aliases could be simply mentioned in the text for backward
compatibility. Big yes! :-)
--
Greetings, TK
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: t.kitynski@gmail.com, bruce@momjian.us, pgsql-docs@lists.postgresql.org
Subject: Re: Suggestion for deprecated spellings
In-Reply-To: <d0f46297-56e6-cf73-8b59-a7b23d675670@gmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox