diff options
| author | Julian Taylor <jtaylor.debian@googlemail.com> | 2014-09-23 22:50:33 +0200 |
|---|---|---|
| committer | Julian Taylor <jtaylor.debian@googlemail.com> | 2014-09-23 22:54:54 +0200 |
| commit | 3b579f7046a0751a1b1976390ece5ba8603b8585 (patch) | |
| tree | 6c2fc08125d5a1a97f17aabbb6742f43dd8d4758 /numpy/add_newdocs.py | |
| parent | 7be6655c34c2e25232964079818fffe0d7d03696 (diff) | |
| download | numpy-3b579f7046a0751a1b1976390ece5ba8603b8585.tar.gz | |
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]
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 10 |
1 files changed, 1 insertions, 9 deletions
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 |