Re: Suggestion for deprecated spellings

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: t(dot)kitynski(at)gmail(dot)com, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Suggestion for deprecated spellings
Date: 2023-01-30 20:39:32
Message-ID: Y9grBFU+2DBXBB7z@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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.

--
Bruce Momjian <bruce(at)momjian(dot)us> https://momjian.us
EDB https://enterprisedb.com

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

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tomisław Kityński 2023-01-30 20:52:15 Re: Suggestion for deprecated spellings
Previous Message Tom Lane 2023-01-26 16:34:55 Re: Not an error but a difficult wording