diff options
| author | Sebastian Berg <sebastian@sipsolutions.net> | 2022-07-05 17:38:57 -0700 |
|---|---|---|
| committer | Sebastian Berg <sebastian@sipsolutions.net> | 2022-07-05 17:38:57 -0700 |
| commit | 3163ae3d6ec2e791607df6c33dedeba311ed5c51 (patch) | |
| tree | aa70d0c2fbe953195f0fc6712c5ac85e2dccbc35 /doc/source/reference/c-api | |
| parent | b6de7bc0dcadac314fcb9ecb6c0d59f91aadb3ed (diff) | |
| download | numpy-3163ae3d6ec2e791607df6c33dedeba311ed5c51.tar.gz | |
DOC: Adopt changes as suggested in review
Co-authored-by: Charles Harris <charlesr.harris@gmail.com>
Diffstat (limited to 'doc/source/reference/c-api')
| -rw-r--r-- | doc/source/reference/c-api/array.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index 8c0acd418..ccff2ae91 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -1332,12 +1332,13 @@ Special functions for NPY_OBJECT NumPy itself accepts ``NULL`` as an alias for ``None``, but may ``assert`` non-``NULL`` when compiled in debug mode. - Users **must** expect a value of ``NULL`` when working with buffers created + Because NumPy is not yet consistent about initialization with None, + users **must** expect a value of ``NULL`` when working with buffers created by NumPy. Users **should** also ensure to pass fully initialized buffers to NumPy, since NumPy may make this a strong requirement in the future. There is currently an intention to ensure that NumPy always initalizes - object arrays before it may be read. Any failure to do so will be + object arrays before they may be read. Any failure to do so will be regarded as a bug. In the future, users may be able to rely on non-NULL values when reading from any array, although exceptions for writing to freshly created arrays |