This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author jtaylor
Recipients jtaylor
Date 2014-01-25.12:37:19
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1390653440.27.0.247965137131.issue20389@psf.upfronthosting.co.za>
In-reply-to
Content
the pvariance and variance functions take the argument mu and xbar to pass the population and sample mean to avoid some recomputation.

I assume the keyword arguments are different because the two means accepted are different, but the docstring does not indicate this directly.
It just says mu or xbar is the mean of the data. The module documentation is a little clearer but only in the grey box right at the end.

I would propose to change the docstring and module documentation to explicitly state that mu is the population mean and xbar is the population mean.
E.g.

- The optional argument mu, if given, should be the mean of
the data.
+ The optional argument mu, if given, should be the population mean of
the data.

etc.
History
Date User Action Args
2014-01-25 12:37:20jtaylorsetrecipients: + jtaylor
2014-01-25 12:37:20jtaylorsetmessageid: <1390653440.27.0.247965137131.issue20389@psf.upfronthosting.co.za>
2014-01-25 12:37:20jtaylorlinkissue20389 messages
2014-01-25 12:37:19jtaylorcreate