Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pMb9D-0004zL-2g for pgsql-docs@arkaria.postgresql.org; Mon, 30 Jan 2023 20:53:03 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.92) (envelope-from ) id 1pMb9A-0002D0-6K for pgsql-docs@arkaria.postgresql.org; Mon, 30 Jan 2023 20:53:00 +0000 Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29]) by malur.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pMb99-0002C4-VE for pgsql-docs@lists.postgresql.org; Mon, 30 Jan 2023 20:52:59 +0000 Received: from momjian.us ([72.94.173.45]) by magus.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pMb97-0005uN-8p for pgsql-docs@lists.postgresql.org; Mon, 30 Jan 2023 20:52:59 +0000 Received: from bruce by momjian.us with local (Exim 4.94.2) (envelope-from ) id 1pMb95-00GtdR-OD; Mon, 30 Jan 2023 15:52:55 -0500 Date: Mon, 30 Jan 2023 15:52:55 -0500 From: Bruce Momjian To: =?utf-8?Q?Tomis=C5=82aw_Kity=C5=84ski?= Cc: pgsql-docs@lists.postgresql.org Subject: Re: Suggestion for deprecated spellings Message-ID: References: <167473556945.2667294.2003897901995802549@wrigleys.postgresql.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Archived-At: Precedence: bulk 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 https://momjian.us EDB https://enterprisedb.com Embrace your flaws. They make you human, rather than perfect, which you will never be.