Re: Documenting removal of nonnullvalue() and friends - Mailing list pgsql-docs

From Tom Lane
Subject Re: Documenting removal of nonnullvalue() and friends
Date
Msg-id 18056.1287067091@sss.pgh.pa.us
Whole thread Raw
In response to Re: Documenting removal of nonnullvalue() and friends  (Josh Kupershmidt <schmiddy@gmail.com>)
List pgsql-docs
Josh Kupershmidt <schmiddy@gmail.com> writes:
> I'm curious now, though: are there any other functions which we're
> leaving intentionally undocumented?

Practically all the functions underlying operators are undocumented, eg
int4pl(int, int).  (If you consider IS NOT NULL to be an operator, then
nonnullvalue is exactly one of those.)  It's possible for people to use
those directly but it's discouraged.  I do *not* want to add them to the
docs, because (a) I do *not* want people to use them directly and (b)
there are a hell of a lot of them, so the docs would get much much
longer with no actual added value.

Perhaps what we should really add to the docs is a statement that use of
undocumented functions is deprecated and we will not be responsible when
your code breaks because one of those is changed or removed.

            regards, tom lane

pgsql-docs by date:

Previous
From: Tom Lane
Date:
Subject: Re: Documenting removal of nonnullvalue() and friends
Next
From: Peter Eisentraut
Date:
Subject: Re: Documenting removal of nonnullvalue() and friends