summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2015-11-15 12:49:21 -0700
committerCharles Harris <charlesr.harris@gmail.com>2015-11-15 12:49:21 -0700
commitcf66c68c6a560c934f4a767934573c7f85dcb4ae (patch)
treea0f5dc11ac9624e60f92b3dba6117ab85d152be8 /numpy
parenteeba2cbfa4c56447e36aad6d97e323ecfbdade56 (diff)
parent35c2d9c9bb597be696005e325742fb8ae3e8f117 (diff)
downloadnumpy-cf66c68c6a560c934f4a767934573c7f85dcb4ae.tar.gz
Merge pull request #6681 from griffin-h/polyfit/weight_doc_update
add clarification of weights to documentation for polyfit
Diffstat (limited to 'numpy')
-rw-r--r--numpy/lib/polynomial.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/numpy/lib/polynomial.py b/numpy/lib/polynomial.py
index de9376300..2f677438b 100644
--- a/numpy/lib/polynomial.py
+++ b/numpy/lib/polynomial.py
@@ -427,7 +427,8 @@ def polyfit(x, y, deg, rcond=None, full=False, w=None, cov=False):
default) just the coefficients are returned, when True diagnostic
information from the singular value decomposition is also returned.
w : array_like, shape (M,), optional
- weights to apply to the y-coordinates of the sample points.
+ Weights to apply to the y-coordinates of the sample points. For
+ gaussian uncertainties, use 1/sigma (not 1/sigma**2).
cov : bool, optional
Return the estimate and the covariance matrix of the estimate
If full is True, then cov is not returned.