]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-104337: Clarify random.gammavariate doc entry (#104410)
authorTerry Jan Reedy <tjreedy@udel.edu>
Sun, 14 May 2023 18:45:54 +0000 (14:45 -0400)
committerGitHub <noreply@github.com>
Sun, 14 May 2023 18:45:54 +0000 (14:45 -0400)
* gh-104337: Clarify random.gammavariate doc entry

* Fix parameter markup.

Doc/library/random.rst

index c192919ac62e544bbac34492f4d45a5c66d94e0f..76ae97a8be7e63c145e636e55f484faf44a7025b 100644 (file)
@@ -334,8 +334,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::
 
@@ -346,7 +348,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.