Re: Suggestion for deprecated spellings - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: Suggestion for deprecated spellings
Date
Msg-id Y9guJ2g+4u7wH9iJ@momjian.us
Whole thread Raw
In response to Suggestion for deprecated spellings  (PG Doc comments form <noreply@postgresql.org>)
List pgsql-docs
On Mon, Jan 30, 2023 at 09:52:15PM +0100, Tomisław Kityński wrote:
> 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! :-)

Right.  What examples of these do we have in our docs?  Just these?

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

Embrace your flaws.  They make you human, rather than perfect,
which you will never be.



pgsql-docs by date:

Previous
From: Tomisław Kityński
Date:
Subject: Re: Suggestion for deprecated spellings
Next
From: Tom Lane
Date:
Subject: Re: Suggestion for deprecated spellings