Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
May 14, 2023
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e69c3e8
gh-104337: Clarify random.gammavariate doc entry
terryjreedy May 11, 2023
27662d0
Fix parameter markup.
terryjreedy May 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions Doc/library/random.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

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

Expand Down