Re: BUG #2467: Documentation

Tom Lane wrote:
> "Rae Stiening" <stiening(at)stiening(dot)com> writes:
> > Description of the "width_bucket(...)"
>
> > "return the bucket to which operand would be assigned in an equidepth
> > histogram with count buckets, an upper bound of b1, and a lower bound of
> > b2"
>
> > I believe that the lower bound is b1 and upper b2.
>
> I agree that this is a typo, but looking at the spec and the function
> code, the description seems misleading altogether. Apparently b1 > b2
> is allowed and the computation is effectively negated then (the buckets
> are numbered in descending rather than ascending order). So ISTM that
> just switching "lower" and "upper" in the text doesn't really get us to
> the point of adequately documenting the function. But the description
> is already too long to fit comfortably in the table, so adding another
> sentence to cover the b1 > b2 case isn't attractive.
>
> Any ideas what to do? Would "starting bound" and "ending bound" work,
> or just confuse people more?

I generalized the documentation section for this function.

--
Bruce Momjian bruce(at)momjian(dot)us
EnterpriseDB http://www.enterprisedb.com

+ If your life is a hard drive, Christ can be your backup. +