public inbox for [email protected]  

help / color / mirror / Atom feed

From: David G. Johnston <[email protected]>
To: [email protected] <[email protected]>
To: [email protected] <[email protected]>
Subject: Re: Adding a Column documentation is misleading
Date: Wed, 6 Nov 2019 07:12:17 -0700
Message-ID: <CAKFQuwbxV27-WBz3b8QxbcrBAEXuvqmEWUM2eA8MAeHnwC6d=A@mail.gmail.com> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>

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.

view thread (4+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: Adding a Column documentation is misleading
  In-Reply-To: <CAKFQuwbxV27-WBz3b8QxbcrBAEXuvqmEWUM2eA8MAeHnwC6d=A@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox