Skip to content

Commit

Permalink
pythongh-64588: Clarify the difference between mu and xbar in statist…
Browse files Browse the repository at this point in the history
…ics docs (python#117333)

Thanks Davin Potts for the clarification idea.
  • Loading branch information
felixxm authored Apr 19, 2024
1 parent 6099fdf commit fefd5d9
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions Doc/library/statistics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -501,9 +501,9 @@ However, for reading convenience, most of the examples show sorted sequences.
variance indicates that the data is spread out; a small variance indicates
it is clustered closely around the mean.

If the optional second argument *mu* is given, it is typically the mean of
the *data*. It can also be used to compute the second moment around a
point that is not the mean. If it is missing or ``None`` (the default),
If the optional second argument *mu* is given, it should be the *population*
mean of the *data*. It can also be used to compute the second moment around
a point that is not the mean. If it is missing or ``None`` (the default),
the arithmetic mean is automatically calculated.

Use this function to calculate the variance from the entire population. To
Expand Down Expand Up @@ -573,8 +573,8 @@ However, for reading convenience, most of the examples show sorted sequences.
the data is spread out; a small variance indicates it is clustered closely
around the mean.

If the optional second argument *xbar* is given, it should be the mean of
*data*. If it is missing or ``None`` (the default), the mean is
If the optional second argument *xbar* is given, it should be the *sample*
mean of *data*. If it is missing or ``None`` (the default), the mean is
automatically calculated.

Use this function when your data is a sample from a population. To calculate
Expand All @@ -590,8 +590,8 @@ However, for reading convenience, most of the examples show sorted sequences.
>>> variance(data)
1.3720238095238095

If you have already calculated the mean of your data, you can pass it as the
optional second argument *xbar* to avoid recalculation:
If you have already calculated the sample mean of your data, you can pass it
as the optional second argument *xbar* to avoid recalculation:

.. doctest::

Expand Down

0 comments on commit fefd5d9

Please sign in to comment.