summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBas van Beek <b.f.van.beek@vu.nl>2021-10-04 17:10:44 +0200
committerBas van Beek <43369155+BvB93@users.noreply.github.com>2021-10-04 19:04:23 +0200
commita0748676e08da4835ff6eccab0f143b28fb6fb81 (patch)
tree5406b7e7fa470838ce3d62c45b0a3e4edd1505e9 /doc
parent0437a2518c9f2b33c054c21bc84cd7c1a4880080 (diff)
downloadnumpy-a0748676e08da4835ff6eccab0f143b28fb6fb81.tar.gz
DOC: Add a release note for the new `nan<x>`parameters
Diffstat (limited to 'doc')
-rw-r--r--doc/release/upcoming_changes/20027.improvement.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/release/upcoming_changes/20027.improvement.rst b/doc/release/upcoming_changes/20027.improvement.rst
new file mode 100644
index 000000000..86b3bed74
--- /dev/null
+++ b/doc/release/upcoming_changes/20027.improvement.rst
@@ -0,0 +1,17 @@
+Missing parameters have been added to the ``nan<x>`` functions
+--------------------------------------------------------------
+A number of the ``nan<x>`` functions previously lacked parameters that were
+present in their ``<x>``-based counterpart, *e.g.* the ``where`` parameter was
+present in `~numpy.mean` but absent from `~numpy.nanmean`.
+
+The following parameters have now been added to the ``nan<x>`` functions:
+
+* nanmin: ``initial`` & ``where``
+* nanmax: ``initial`` & ``where``
+* nanargmin: ``keepdims`` & ``out``
+* nanargmax: ``keepdims`` & ``out``
+* nansum: ``initial`` & ``where``
+* nanprod: ``initial`` & ``where``
+* nanmean: ``where``
+* nanvar: ``where``
+* nanstd: ``where``