Re: docs for random function - Mailing list pgsql-hackers

From Tom Lane
Subject Re: docs for random function
Date
Msg-id 5064.1250452643@sss.pgh.pa.us
Whole thread Raw
In response to docs for random function  (Sam Mason <sam@samason.me.uk>)
Responses Re: docs for random function
List pgsql-hackers
Sam Mason <sam@samason.me.uk> writes:
> The docs for the function random() currently say:
>   random value between 0.0 and 1.0, inclusive
> this isn't a particularly useful invariant, what the code actually does
> (and is commented as doing) is much more useful.  Any chance of changing
> it to something like:

Yeah, it looks like Bruce changed this back in 8.2 and failed to fix
the documentation to match.  I used this wording instead:

***************
*** 821,827 ****       <row>        <entry><literal><function>random</function>()</literal></entry>
<entry><type>dp</type></entry>
!        <entry>random value between 0.0 and 1.0, inclusive</entry>        <entry><literal>random()</literal></entry>
    <entry></entry>       </row>
 
--- 821,827 ----       <row>        <entry><literal><function>random</function>()</literal></entry>
<entry><type>dp</type></entry>
!        <entry>random value in the range 0.0 <= x < 1.0</entry>
<entry><literal>random()</literal></entry>       <entry></entry>       </row>
 

        regards, tom lane


pgsql-hackers by date:

Previous
From: Jan Otto
Date:
Subject: Re: drop tablespace error: invalid argument
Next
From: Sam Mason
Date:
Subject: Re: docs for random function