diff options
| author | Terry Jan Reedy <tjreedy@udel.edu> | 2023-05-14 14:45:54 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-14 14:45:54 -0400 |
| commit | 88c5c586708dcff369c49edae947d487a80f0346 (patch) | |
| tree | 1e058aced7bb72ddd940cb56908818026b903e39 | |
| parent | 2f7b5e458e9189fa1ffd44339848aa1e52add3fa (diff) | |
| download | cpython-git-88c5c586708dcff369c49edae947d487a80f0346.tar.gz | |
gh-104337: Clarify random.gammavariate doc entry (#104410)
* gh-104337: Clarify random.gammavariate doc entry
* Fix parameter markup.
| -rw-r--r-- | Doc/library/random.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/library/random.rst b/Doc/library/random.rst index c192919ac6..76ae97a8be 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. |