From ffb6779d5e28de176f87f90a7130a2be60fad07f Mon Sep 17 00:00:00 2001 From: Bas van Beek Date: Mon, 4 Oct 2021 17:10:44 +0200 Subject: [PATCH] DOC: Add a release note for the new `nan`parameters --- .../upcoming_changes/20027.improvement.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 doc/release/upcoming_changes/20027.improvement.rst diff --git a/doc/release/upcoming_changes/20027.improvement.rst b/doc/release/upcoming_changes/20027.improvement.rst new file mode 100644 index 000000000000..86b3bed744e7 --- /dev/null +++ b/doc/release/upcoming_changes/20027.improvement.rst @@ -0,0 +1,17 @@ +Missing parameters have been added to the ``nan`` functions +-------------------------------------------------------------- +A number of the ``nan`` functions previously lacked parameters that were +present in their ````-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`` 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``