summaryrefslogtreecommitdiff
path: root/doc/source/reference/c-api.array.rst
diff options
context:
space:
mode:
authorMark Wiebe <mwwiebe@gmail.com>2011-08-24 14:03:16 -0700
committerCharles Harris <charlesr.harris@gmail.com>2011-08-27 07:27:01 -0600
commit847404a650757ba8ab6dae3af937890230b00f84 (patch)
treebed404cbe052cf7e671af8baf7fa41a26b049090 /doc/source/reference/c-api.array.rst
parent5459e09ca6874ab0cdd7b6d4b69a068bcd0b12ed (diff)
downloadnumpy-847404a650757ba8ab6dae3af937890230b00f84.tar.gz
DOC: missingdata: Documenting C API for NA-masked arrays
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
-rw-r--r--doc/source/reference/c-api.array.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst
index 369360407..35f5c6030 100644
--- a/doc/source/reference/c-api.array.rst
+++ b/doc/source/reference/c-api.array.rst
@@ -2575,6 +2575,9 @@ Array Scalars
if so, returns the appropriate array scalar. It should be used
whenever 0-dimensional arrays could be returned to Python.
+ If *arr* is a 0-dimensional NA-masked array with its value hidden,
+ an instance of :ctype:`NpyNA *` is returned.
+
.. cfunction:: PyObject* PyArray_Scalar(void* data, PyArray_Descr* dtype, PyObject* itemsize)
Return an array scalar object of the given enumerated *typenum*