From 3b579f7046a0751a1b1976390ece5ba8603b8585 Mon Sep 17 00:00:00 2001 From: Julian Taylor Date: Tue, 23 Sep 2014 22:50:33 +0200 Subject: DOC: remove preservena reference from docstrings preservena is not not implemented. the putmask docstring is misleading, currently copyto is faster for dense or sparse masks while putmask is faster for random masks. [ci skip] --- numpy/add_newdocs.py | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) (limited to 'numpy/add_newdocs.py') diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 86ea4b8b6..64309721c 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -3834,7 +3834,7 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('put', add_newdoc('numpy.core.multiarray', 'copyto', """ - copyto(dst, src, casting='same_kind', where=None, preservena=False) + copyto(dst, src, casting='same_kind', where=None) Copies values from one array to another, broadcasting as necessary. @@ -3862,9 +3862,6 @@ add_newdoc('numpy.core.multiarray', 'copyto', A boolean array which is broadcasted to match the dimensions of `dst`, and selects elements to copy from `src` to `dst` wherever it contains the value True. - preservena : bool, optional - If set to True, leaves any NA values in `dst` untouched. This - is similar to the "hard mask" feature in numpy.ma. """) @@ -3879,11 +3876,6 @@ 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:: 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 ---------- a : array_like -- cgit v1.2.1