From: Terry Jan Reedy <tjreedy@udel.edu>
Date: Sun, 14 May 2023 18:45:54 +0000 (-0400)
Subject:  gh-104337: Clarify random.gammavariate doc entry  (#104410)
X-Git-Tag: v3.12.0b1~127
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=88c5c586708dcff369c49edae947d487a80f0346;p=thirdparty%2FPython%2Fcpython.git

 gh-104337: Clarify random.gammavariate doc entry  (#104410)

* gh-104337: Clarify random.gammavariate doc entry

* Fix parameter markup.
---

diff --git a/Doc/library/random.rst b/Doc/library/random.rst
index c192919ac62e..76ae97a8be7e 100644
--- a/Doc/library/random.rst
+++ b/Doc/library/random.rst
@@ -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.