diff options
| author | Ralf Gommers <ralf.gommers@googlemail.com> | 2012-03-25 14:44:23 +0200 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2012-03-30 05:41:00 -0600 |
| commit | 41f7d21182fddbc71b2100fdb3425a5e7e2f35b6 (patch) | |
| tree | 8832edb9727821436916611d456828a8c612a520 /numpy/add_newdocs.py | |
| parent | f84ac77e50456191a2574913494d1e5ce5a4d92b (diff) | |
| download | numpy-41f7d21182fddbc71b2100fdb3425a5e7e2f35b6.tar.gz | |
DOC: label the current NA implementation as experimental in 1.7.x
This has been extensively discussed on the mailing list. See #2072.
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index dd48191b6..6b7d98c4d 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -685,11 +685,17 @@ add_newdoc('numpy.core.multiarray', 'array', If this is set to False, it forces the array to not have an NA mask. If the input is an array with a mask, and has no NA values, it will create a copy of the input without an NA mask. + + .. versionadded:: 1.7.0 + ownmaskna : bool, optional If this is set to True, forces the array to have a mask which it owns. It may still return a view of the data from the input, but the result will always own its own mask. + .. versionadded:: 1.7.0 + + Returns ------- out : ndarray @@ -699,6 +705,11 @@ add_newdoc('numpy.core.multiarray', 'array', -------- empty, empty_like, zeros, zeros_like, ones, ones_like, fill + Notes + ----- + The `maskna` and `ownmaskna` keywords are *experimental* in the 1.7 + release; their behavior may change in future versions. + Examples -------- >>> np.array([1, 2, 3]) |