Doc: improve documentation about width_bucket().
authorTom Lane <tgl@sss.pgh.pa.us>
Sat, 21 Jun 2025 16:52:37 +0000 (12:52 -0400)
committerTom Lane <tgl@sss.pgh.pa.us>
Sat, 21 Jun 2025 16:52:37 +0000 (12:52 -0400)
commit34a6c679ae35a0cc4645206f1a55d344766dbe1f
tree1a80c0f3da14349791c2eaab9fecedeb72446efc
parent4b66cb18879edd7c9dc89c99e6c7c5c2cd074c70
Doc: improve documentation about width_bucket().

Specify whether the bucket bounds are inclusive or exclusive,
and improve some other vague language.  Explain the behavior that
occurs when the "low" bound is greater than the "high" bound.
Make width_bucket_numeric's comment more like that for
width_bucket_float8, in particular noting that infinite
bounds are rejected (since they became possible in v14).

Reported-by: Ben Peachey Higdon <bpeacheyhigdon@gmail.com>
Author: Robert Treat <rob@xzilla.net>
Co-authored-by: Tom Lane <tgl@sss.pgh.pa.us>
Reviewed-by: Dean Rasheed <dean.a.rasheed@gmail.com>
Discussion: https://postgr.es/m/2BD74F86-5B89-4AC1-8F13-23CED3546AC1@gmail.com
Backpatch-through: 13
doc/src/sgml/func.sgml
src/backend/utils/adt/float.c
src/backend/utils/adt/numeric.c