public inbox for [email protected]  

help / color / mirror / Atom feed

Documentation for alternate names of functions
3+ messages / 3 participants
[nested] [flat]

* Documentation for alternate names of functions
@ 2018-09-04 21:17  Daniel Cory <[email protected]>
  0 siblings, 2 replies; 3+ messages in thread

From: Daniel Cory @ 2018-09-04 21:17 UTC (permalink / raw)
  To: pgsql-docs

Can we document that "pow" is the same as "power"? It is not listed on https://www.postgresql.org/docs/current/static/functions-math.html, even though both "ceil" and "ceiling" are listed.

Can we document "int4larger" and related functions? They are similar to the greatest/least functions but not listed on https://www.postgresql.org/docs/current/static/functions-conditional.html#FUNCTIONS-GREATEST-LEAST

Thanks,
Dan


^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: Documentation for alternate names of functions
@ 2018-09-04 21:36  David G. Johnston <[email protected]>
  parent: Daniel Cory <[email protected]>
  1 sibling, 0 replies; 3+ messages in thread

From: David G. Johnston @ 2018-09-04 21:36 UTC (permalink / raw)
  To: Daniel Cory <[email protected]>; +Cc: pgsql-docs

On Tue, Sep 4, 2018 at 2:17 PM, Daniel Cory <[email protected]> wrote:

> Can we document that “pow” is the same as “power”? It is not listed on
> https://www.postgresql.org/docs/current/static/functions-math.html, even
> though both “ceil” and “ceiling” are listed.
>
> For aliased function names for which only one is SQL standard we should
denote which one.  This particular alias seems worthy of inclusion.


>
>
> Can we document “int4larger” and related functions? They are similar to
> the greatest/least functions but not listed on https://www.postgresql.org/
> docs/current/static/functions-conditional.html#FUNCTIONS-GREATEST-LEAST
>

I don't see the point of exposing this implementation detail when the
greatest/least expressions (i.e., they don't appear under \df), though
non-standard, are what users are encouraged to use.  Not sure we'd turn
down a patch but its not something I'd expect to get picked up in a timely
fashion.

David J.


^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* Re: Documentation for alternate names of functions
@ 2018-09-04 21:57  Tom Lane <[email protected]>
  parent: Daniel Cory <[email protected]>
  1 sibling, 0 replies; 3+ messages in thread

From: Tom Lane @ 2018-09-04 21:57 UTC (permalink / raw)
  To: Daniel Cory <[email protected]>; +Cc: pgsql-docs

Daniel Cory <[email protected]> writes:
> Can we document that "pow" is the same as "power"?

Meh.  power() is the SQL-standard spelling; I don't see a good reason to
encourage people to use the legacy name.  We might hope to get rid of
that name someday (cf commit fc7fd5018).

> Can we document "int4larger" and related functions?

We intentionally do *not* document functions that are only meant to be
used as infrastructure for operators and aggregates.  If we did, the
tables would be far larger and would just encourage people to use
functions we'd prefer they didn't.  As with the pow() case, this'd
basically be enlarging our exposed surface of frozen API, and I don't
think that's desirable.

			regards, tom lane





^ permalink  raw  reply  [nested|flat] 3+ messages in thread

end of thread, other threads:[~2018-09-04 21:57 UTC | newest]

Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2018-09-04 21:17 Documentation for alternate names of functions Daniel Cory <[email protected]>
2018-09-04 21:36 ` David G. Johnston <[email protected]>
2018-09-04 21:57 ` Tom Lane <[email protected]>

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