diff options
| author | Stuart Archibald <stuart.archibald@googlemail.com> | 2016-09-23 11:46:23 +0100 |
|---|---|---|
| committer | Stuart Archibald <stuart.archibald@googlemail.com> | 2016-09-23 11:46:23 +0100 |
| commit | 8478ba7e9d12272e70931878c83127cb7290d9c6 (patch) | |
| tree | 9c2ecc7f89be519ff189c6ab31c1739eb629a140 /numpy/lib/polynomial.py | |
| parent | 6463a760273a43441e96db7713c443136196d850 (diff) | |
| download | numpy-8478ba7e9d12272e70931878c83127cb7290d9c6.tar.gz | |
DOC: Fix erroneous return type description for np.roots.
np.roots() does not always return complex roots, the
roots of a polynomial depend its coefficients and
therefore may be in the real or complex domain.
e.g.
```
>>> (np.roots([1,2,3])).dtype
dtype('complex128')
>>> (np.roots([1,2,])).dtype
dtype('float64')
```
Diffstat (limited to 'numpy/lib/polynomial.py')
| -rw-r--r-- | numpy/lib/polynomial.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/numpy/lib/polynomial.py b/numpy/lib/polynomial.py index 81c72749a..281d79ec5 100644 --- a/numpy/lib/polynomial.py +++ b/numpy/lib/polynomial.py @@ -167,7 +167,7 @@ def roots(p): Returns ------- out : ndarray - An array containing the complex roots of the polynomial. + An array containing the roots of the polynomial. Raises ------ |