From 938e21ea981ca4e7bbdd9855ac806d5506984c2c Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Sun, 14 May 2023 14:45:54 -0400 Subject: [PATCH] gh-104337: Clarify random.gammavariate doc entry (GH-104410) * gh-104337: Clarify random.gammavariate doc entry * Fix parameter markup. (cherry picked from commit 88c5c586708dcff369c49edae947d487a80f0346) Co-authored-by: Terry Jan Reedy --- Doc/library/random.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Doc/library/random.rst b/Doc/library/random.rst index c7620b03284345..3109343a3c52df 100644 --- a/Doc/library/random.rst +++ b/Doc/library/random.rst @@ -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.