Re: Adding a Column documentation is misleading

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: "gavinflower(at)archidevsys(dot)co(dot)nz" <gavinflower(at)archidevsys(dot)co(dot)nz>, "pgsql-docs(at)lists(dot)postgresql(dot)org" <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Adding a Column documentation is misleading
Date: 2019-11-06 14:12:17
Message-ID: CAKFQuwbxV27-WBz3b8QxbcrBAEXuvqmEWUM2eA8MAeHnwC6d=A@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Tuesday, November 5, 2019, PG Doc comments form <noreply(at)postgresql(dot)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.

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2019-11-06 18:59:35 Re: Does 'instead of delete' trigger support modification of OLD
Previous Message Bruce Momjian 2019-11-06 13:33:28 Re: Why 'infinity' is not in range '[2019-01-02, infinity]'?