diff options
| author | Warren Weckesser <warren.weckesser@gmail.com> | 2020-08-12 20:41:23 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-12 19:41:23 -0500 |
| commit | b4fd7a79bc55f17f301d219492528e6f5f40c6f0 (patch) | |
| tree | 244ffaa0968549d474580eaaf17dc4f97aedc42e /doc | |
| parent | 2b54640ad50bbbfecfb4c9cc8c9dd9c161f6a52e (diff) | |
| download | numpy-b4fd7a79bc55f17f301d219492528e6f5f40c6f0.tar.gz | |
DEP: lib: Remove the deprecated financial functions. (#17067)
As explained in NEP 32, the financial functions are to be removed
from version 1.20.
They are now replaced with module level `__getattr__` to give a useful
error message for those surprised by the `AttributeError`.
This only works for Python 3.7+, but it is expected that by the 1.20 release
Python 3.6 will not be supported.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/release/upcoming_changes/17067.expired.rst | 8 | ||||
| -rw-r--r-- | doc/source/reference/routines.financial.rst | 21 | ||||
| -rw-r--r-- | doc/source/reference/routines.rst | 1 |
3 files changed, 8 insertions, 22 deletions
diff --git a/doc/release/upcoming_changes/17067.expired.rst b/doc/release/upcoming_changes/17067.expired.rst new file mode 100644 index 000000000..a1065d2c3 --- /dev/null +++ b/doc/release/upcoming_changes/17067.expired.rst @@ -0,0 +1,8 @@ +Financial functions removed +--------------------------- +In accordance with NEP 32, the financial functions are removed +from NumPy 1.20. The functions that have been removed are ``fv``, +``ipmt``, ``irr``, ``mirr``, ``nper``, ``npv``, ``pmt``, ``ppmt``, +``pv``, and ``rate``. These functions are available in the +`numpy_financial <https://pypi.org/project/numpy-financial>`_ +library. diff --git a/doc/source/reference/routines.financial.rst b/doc/source/reference/routines.financial.rst deleted file mode 100644 index 5f426d7ab..000000000 --- a/doc/source/reference/routines.financial.rst +++ /dev/null @@ -1,21 +0,0 @@ -Financial functions -******************* - -.. currentmodule:: numpy - -Simple financial functions --------------------------- - -.. autosummary:: - :toctree: generated/ - - fv - pv - npv - pmt - ppmt - ipmt - irr - mirr - nper - rate diff --git a/doc/source/reference/routines.rst b/doc/source/reference/routines.rst index 7a9b97d77..5d6a823b7 100644 --- a/doc/source/reference/routines.rst +++ b/doc/source/reference/routines.rst @@ -28,7 +28,6 @@ indentation. routines.emath routines.err routines.fft - routines.financial routines.functional routines.help routines.indexing |