summaryrefslogtreecommitdiff
path: root/numpy/lib/polynomial.py
diff options
context:
space:
mode:
authorMelissa Weber Mendonça <melissawm@gmail.com>2020-07-15 22:21:05 -0300
committerGitHub <noreply@github.com>2020-07-15 22:21:05 -0300
commit92665ab229a2426db33bcfaa65cd73493acbad95 (patch)
treec761f8dc83f0b91ad0e8483ac3a1bd7d02fa8e6f /numpy/lib/polynomial.py
parent253b383b386fee64ec5e14f670313380f8847605 (diff)
parentec53b0323b37bdca5badac405ffbb6e7600c676b (diff)
downloadnumpy-92665ab229a2426db33bcfaa65cd73493acbad95.tar.gz
Merge pull request #16878 from davidedalbosco/patch-1
DOC: edit to the documentation of lib/polynomial.py/polyfit
Diffstat (limited to 'numpy/lib/polynomial.py')
-rw-r--r--numpy/lib/polynomial.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/numpy/lib/polynomial.py b/numpy/lib/polynomial.py
index 420ec245b..1c124cc0e 100644
--- a/numpy/lib/polynomial.py
+++ b/numpy/lib/polynomial.py
@@ -494,11 +494,12 @@ def polyfit(x, y, deg, rcond=None, full=False, w=None, cov=False):
cov : bool or str, optional
If given and not `False`, return not just the estimate but also its
covariance matrix. By default, the covariance are scaled by
- chi2/sqrt(N-dof), i.e., the weights are presumed to be unreliable
- except in a relative sense and everything is scaled such that the
- reduced chi2 is unity. This scaling is omitted if ``cov='unscaled'``,
- as is relevant for the case that the weights are 1/sigma**2, with
- sigma known to be a reliable estimate of the uncertainty.
+ chi2/dof, where dof = M - (deg + 1), i.e., the weights are presumed
+ to be unreliable except in a relative sense and everything is scaled
+ such that the reduced chi2 is unity. This scaling is omitted if
+ ``cov='unscaled'``, as is relevant for the case that the weights are
+ 1/sigma**2, with sigma known to be a reliable estimate of the
+ uncertainty.
Returns
-------