Re: Adding a Column documentation is misleading - Mailing list pgsql-docs

From David G. Johnston
Subject Re: Adding a Column documentation is misleading
Date
Msg-id CAKFQuwbxV27-WBz3b8QxbcrBAEXuvqmEWUM2eA8MAeHnwC6d=A@mail.gmail.com
Whole thread Raw
In response to Adding a Column documentation is misleading  (PG Doc comments form <noreply@postgresql.org>)
List pgsql-docs
On Tuesday, November 5, 2019, PG Doc comments form <noreply@postgresql.org> wrote:
The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/12/ddl-alter.html
Description:

In 5.6.1. Adding a Column, there is a kind of example 'ALTER TABLE products
ADD COLUMN description text;'

The words 'description' and 'text' are misleading -- as according to the
formal documentation of the SQL command
(https://www.postgresql.org/docs/12/sql-altertable.html), they should be
'column_name' and 'data_type'.

A similar problem exists for removing a column, and other actions.

Chapter 5 is tutorial-like and uses actual meaningful names instead of syntax placeholders.  I don’t really see a problem aside from maybe a different example name could be chosen.  Making it column_name isn’t an improvement.

David J. 

pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: Why 'infinity' is not in range '[2019-01-02, infinity]'?
Next
From: Tatsuo Ishii
Date:
Subject: Small typo in func.sgml