Re: psql's commit df9f599b is not documented

From: Dave Cramer <davecramer(at)postgres(dot)rocks>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>, mali_86(at)outlook(dot)com, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: psql's commit df9f599b is not documented
Date: 2021-08-03 10:39:21
Message-ID: CADK3HHLQCAKp+jHM2r5e_wigpyPBE+ineuVNYdj3qdziVMvkGw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Mon, 2 Aug 2021 at 20:56, Bruce Momjian <bruce(at)momjian(dot)us> wrote:

> On Mon, Aug 2, 2021 at 05:24:14PM -0700, David G. Johnston wrote:
> > On Mon, Aug 2, 2021 at 5:03 PM Bruce Momjian <bruce(at)momjian(dot)us> wrote:
> >
> >
> > I think we put it in the PG 11 release notes so people who used
> Postgres
> > previously would know this item is improved, but for new folks, it
> will
> > just work if they try it, but we don't want to encourage them to try
> it.
> >
> >
> >
> > And why do we care about informing people those people of this
> undocumented
> > behavior? It's not like we want to encourage them to use it either.
> >
> > I stand by my conviction that a release note entry for a user-visible
> feature
> > requires having documented said feature in the main documentation - and
> > vice-versa.
>

I would agree. If it's worth coding it's worth documenting. Unless of
course the intention is that this is temporary.

I would also argue that putting them in the release notes is not enough. Am
I expected to go through the release notes after I don't find it in the
documentation ?
Do we have other undocumented features ?

Dave Cramer
>
>
>
>

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message David G. Johnston 2021-08-03 12:24:09 Re: psql's commit df9f599b is not documented
Previous Message Bruce Momjian 2021-08-03 00:56:02 Re: psql's commit df9f599b is not documented