Skip to content

Commit

Permalink
pythongh-104337: Clarify random.gammavariate doc entry (pythonGH-104410)
Browse files Browse the repository at this point in the history
* pythongh-104337: Clarify random.gammavariate doc entry

* Fix parameter markup.
(cherry picked from commit 88c5c58)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
  • Loading branch information
terryjreedy authored and miss-islington committed May 14, 2023
1 parent f5f9975 commit 938e21e
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Doc/library/random.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand All @@ -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.

Expand Down

0 comments on commit 938e21e

Please sign in to comment.