diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2014-09-23 15:18:52 -0600 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2014-09-23 15:18:52 -0600 |
| commit | d7fd1e8d8b97db7efbb9c1ff02e96fb9948bfb1a (patch) | |
| tree | 254969bde19cfbc42bae3b7606edb6a409339899 /numpy/add_newdocs.py | |
| parent | 55544881b5784fca7d4e26effd5b89ccc86f9534 (diff) | |
| parent | 3b579f7046a0751a1b1976390ece5ba8603b8585 (diff) | |
| download | numpy-d7fd1e8d8b97db7efbb9c1ff02e96fb9948bfb1a.tar.gz | |
Merge pull request #5107 from juliantaylor/na-doc
DOC: remove preservena reference from docstrings
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 6f3a10de4..0a48f1ade 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -3797,7 +3797,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. @@ -3825,9 +3825,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. """) @@ -3842,11 +3839,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 |