diff options
author | Chiara Marmo <chiara.marmo@inria.fr> | 2021-08-01 16:16:04 +0200 |
---|---|---|
committer | Chiara Marmo <chiara.marmo@inria.fr> | 2021-08-01 16:16:04 +0200 |
commit | f212b224c7771ca536f27ddcaf9f4ed930f33f58 (patch) | |
tree | a40b3a466a8f685af2f7825f44cb068124b4fce2 /doc/source/reference/c-api/array.rst | |
parent | 2c1a34daa024398cdf9c6e1fbeff52b4eb280551 (diff) | |
download | numpy-f212b224c7771ca536f27ddcaf9f4ed930f33f58.tar.gz |
Fix scope of c:macro.
Diffstat (limited to 'doc/source/reference/c-api/array.rst')
-rw-r--r-- | doc/source/reference/c-api/array.rst | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index d943ba533..901affe8b 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -1540,6 +1540,19 @@ specify desired properties of the new array. Make sure the resulting object is an actual ndarray, and not a sub-class. +These constant are used in :c:func:`PyArray_DescrNewByteorder` to describe the +byteorder of the new datatype. + +.. c:macro:: NPY_IGNORE + +.. c:macro:: NPY_SWAP + +.. c:macro:: NPY_NATIVE + +.. c:macro:: NPY_LITTLE + +.. c:macro:: NPY_BIG + Flag checking ^^^^^^^^^^^^^ @@ -2836,15 +2849,6 @@ Data-type descriptors *newendian*. All referenced data-type objects (in subdescr and fields members of the data-type object) are also changed (recursively). - - The value of *newendian* is one of these macros: - - .. c:macro:: NPY_IGNORE - NPY_SWAP - NPY_NATIVE - NPY_LITTLE - NPY_BIG - If a byteorder of :c:data:`NPY_IGNORE` is encountered it is left alone. If newendian is :c:data:`NPY_SWAP`, then all byte-orders are swapped. Other valid newendian values are :c:data:`NPY_NATIVE`, |