summaryrefslogtreecommitdiff
path: root/numpy/dual.py
diff options
context:
space:
mode:
authorWarren Weckesser <warren.weckesser@gmail.com>2020-05-05 10:19:47 -0400
committerWarren Weckesser <warren.weckesser@gmail.com>2020-05-05 10:19:47 -0400
commitbd58b471ad86ea402a639bbfe517bd61ebb97c31 (patch)
tree8e3e3c25ce46ad56c05c1c7597d45d696af10dbd /numpy/dual.py
parente95fcba32f123dc3ea6e23f533fedf5aee64815e (diff)
downloadnumpy-bd58b471ad86ea402a639bbfe517bd61ebb97c31.tar.gz
DOC: dual: Note the deprecation of numpy.dual in the dual module docstring.
Also make the correction "Scipy" -> "SciPy" in a few places.
Diffstat (limited to 'numpy/dual.py')
-rw-r--r--numpy/dual.py14
1 files changed, 10 insertions, 4 deletions
diff --git a/numpy/dual.py b/numpy/dual.py
index 9200a054e..eb7e61aac 100644
--- a/numpy/dual.py
+++ b/numpy/dual.py
@@ -1,13 +1,19 @@
"""
-Aliases for functions which may be accelerated by Scipy.
+.. deprecated:: 1.20
-Scipy_ can be built to use accelerated or otherwise improved libraries
+*This module is deprecated. Instead of importing functions from*
+``numpy.dual``, *the functions should be imported directly from NumPy
+or SciPy*.
+
+Aliases for functions which may be accelerated by SciPy.
+
+SciPy_ can be built to use accelerated or otherwise improved libraries
for FFTs, linear algebra, and special functions. This module allows
developers to transparently support these accelerated functions when
-scipy is available but still support users who have only installed
+SciPy is available but still support users who have only installed
NumPy.
-.. _Scipy : https://www.scipy.org
+.. _SciPy : https://www.scipy.org
"""
import warnings