diff options
author | kai-striega <kaistriega@gmail.com> | 2019-09-14 13:18:34 +0800 |
---|---|---|
committer | kai-striega <kaistriega@gmail.com> | 2019-09-14 13:44:36 +0800 |
commit | 58dc45505b3d3e2b9de1a6961a749c8bd1165548 (patch) | |
tree | ea0e0749dabaabda400968e4babd5c368de969b5 /numpy/lib/utils.py | |
parent | a6729a0e43791069cbc3cf5e80c34c73fa752b4d (diff) | |
download | numpy-58dc45505b3d3e2b9de1a6961a749c8bd1165548.tar.gz |
DOC: Add warning message to np.npv docs
``np.npv`` calculates the present value of a series of cashflows
starting in the present (t=0). Another common definition of NPV
uses the future cashflows i.e. starting at the end of the first
period.
The difference in definition can lead to confusion for users moving
between NumPy and other projects [1] and adds complexity for
maintainers [2]. This commit adds a warning to the ``npv``
function's documentation and adds an example on how to find the npv
of a project using the alternate definition.
[1] https://github.com/numpy/numpy/issue/10877
[2] https://github.com/numpy/numpy/pull/3346
Diffstat (limited to 'numpy/lib/utils.py')
0 files changed, 0 insertions, 0 deletions