Re: Adding a Column documentation is misleading
"David G. Johnston" <[email protected]> Wed, 6 Nov 2019 07:12:17 -0700
| Newsgroups | gmane.comp.db.postgresql.devel.documentation |
|---|---|
| Message-ID | <CAKFQuwbxV27-WBz3b8QxbcrBAEXuvqmEWUM2eA8MAeHnwC6d=A@mail.gmail.com> |
On Tuesday, November 5, 2019, PG Doc comments form <[email protected]> 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.