summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@googlemail.com>2011-12-29 18:21:05 +0100
committerCharles Harris <charlesr.harris@gmail.com>2011-12-30 19:26:02 -0700
commit3d9bedb70f2fe2761a3ee123004ccbba0f037b2e (patch)
tree90bba208524017a66a7c8fa45ae86bd36f2a8954 /numpy/add_newdocs.py
parent8c113493f1f6d88f2829afcbcd3d28312751e610 (diff)
downloadnumpy-3d9bedb70f2fe2761a3ee123004ccbba0f037b2e.tar.gz
DOC: putmask: mention copyto is NA-aware, and recommend to switch to it.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index a3b00925f..ab4dc5681 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -3870,8 +3870,10 @@ add_newdoc('numpy.core.multiarray', 'putmask',
If `values` is not the same size as `a` and `mask` then it will repeat.
This gives behavior different from ``a[mask] = values``.
- Note that the `putmask` functionality is also provided by `copyto`, which
- can be significantly faster. Use ``np.copyto(a, values, where=mask)``.
+ .. note:: The `putmask` functionality is also provided by `copyto`, which
+ can be significantly faster and in addition is NA-aware
+ (`preservena` keyword). Replacing `putmask` with
+ ``np.copyto(a, values, where=mask)`` is recommended.
Parameters
----------