Date: Mon, 30 Jan 2023 15:39:32 -0500
From: Bruce Momjian <bruce@momjian.us>
To: t.kitynski@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: Suggestion for deprecated spellings
Message-ID: <Y9grBFU+2DBXBB7z@momjian.us>
References: <167473556945.2667294.2003897901995802549@wrigleys.postgresql.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: 
 <167473556945.2667294.2003897901995802549@wrigleys.postgresql.org>
Archived-At: 
 <https://www.postgresql.org/message-id/Y9grBFU%2B2DBXBB7z%40momjian.us>
Precedence: bulk

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@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

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