DOC: dual: Note the deprecation of numpy.dual in the dual module docs…

…tring. Also make the correction "Scipy" -> "SciPy" in a few places.
everpeace · May 5, 2020 · bd58b47 · bd58b47
1 parent e95fcba
commit bd58b47
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/doc/source/reference/routines.dual.rst b/doc/source/reference/routines.dual.rst
@@ -1,4 +1,4 @@
-Optionally Scipy-accelerated routines (:mod:`numpy.dual`)
+Optionally SciPy-accelerated routines (:mod:`numpy.dual`)
 *********************************************************
 
 .. automodule:: numpy.dual

diff --git 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