8000 Merge pull request #5107 from juliantaylor/na-doc · numpy/numpy@a2bfd3f · GitHub
[go: up one dir, main page]

Skip to content

Commit a2bfd3f

Browse files
committed
Merge pull request #5107 from juliantaylor/na-doc
DOC: remove preservena reference from docstrings
2 parents 26052d7 + 3b579f7 commit a2bfd3f

File tree

1 file changed

+1
-9
lines changed

1 file changed

+1
-9
lines changed

numpy/add_newdocs.py

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3834,7 +3834,7 @@ def luf(lamdaexpr, *args, **kwargs):
38343834

38353835
add_newdoc('numpy.core.multiarray', 'copyto',
38363836
"""
3837-
copyto(dst, src, casting='same_kind', where=None, preservena=False)
3837+
copyto(dst, src, casting='same_kind', where=None)
38383838
38393839
Copies values from one array to another, broadcasting as necessary.
38403840
@@ -3862,9 +3862,6 @@ def luf(lamdaexpr, *args, **kwargs):
38623862
A boolean array which is broadcasted to match the dimensions
38633863
of `dst`, and selects elements to copy from `src` to `dst`
38643864
wherever it contains the value True.
3865-
preservena : bool, optional
3866-
If set to True, leaves any NA values in `dst` untouched. This
3867-
is similar to the "hard mask" feature in numpy.ma.
38683865
38693866
""")
38703867

@@ -3879,11 +3876,6 @@ def luf(lamdaexpr, *args, **kwargs):
38793876
If `values` is not the same size as `a` and `mask` then it will repeat.
38803877
This gives behavior different from ``a[mask] = values``.
38813878
3882-
.. note:: The `putmask` functionality is also provided by `copyto`, which
3883-
can be significantly faster and in addition is NA-aware
3884-
(`preservena` keyword). Replacing `putmask` with
3885-
``np.copyto(a, values, where=mask)`` is recommended.
3886-
38873879
Parameters
38883880
----------
38893881
a : array_like

0 commit comments

Comments
 (0)
0