]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-104337: Clarify random.gammavariate doc entry (GH-104410) (#104481)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 14 May 2023 20:25:25 +0000 (13:25 -0700)
committerGitHub <noreply@github.com>
Sun, 14 May 2023 20:25:25 +0000 (16:25 -0400)
(cherry picked from commit 88c5c586708dcff369c49edae947d487a80f0346)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Doc/library/random.rst

index c7620b03284345326c9cf9ec14448effb0d2f8f0..3109343a3c52df5d13fc4e679b7a0f454f4cfc5e 100644 (file)
@@ -310,8 +310,10 @@ be found in any statistics text.
 
 .. function:: gammavariate(alpha, beta)
 
-   Gamma distribution.  (*Not* the gamma function!)  Conditions on the
-   parameters are ``alpha > 0`` and ``beta > 0``.
+   Gamma distribution.  (*Not* the gamma function!)  The shape and
+   scale parameters, *alpha* and *beta*, must have positive values.
+   (Calling conventions vary and some sources define 'beta'
+   as the inverse of the scale).
 
    The probability distribution function is::
 
@@ -322,7 +324,8 @@ be found in any statistics text.
 
 .. function:: gauss(mu=0.0, sigma=1.0)
 
-   Normal distribution, also called the Gaussian distribution.  *mu* is the mean,
+   Normal distribution, also called the Gaussian distribution.
+   *mu* is the mean,
    and *sigma* is the standard deviation.  This is slightly faster than
    the :func:`normalvariate` function defined below.