diff options
| author | Chiara Marmo <chiara.marmo@inria.fr> | 2021-08-02 20:22:31 +0200 |
|---|---|---|
| committer | Chiara Marmo <chiara.marmo@inria.fr> | 2021-08-02 20:22:31 +0200 |
| commit | b3239c67acc85c2bd649548598971ac9b390bad0 (patch) | |
| tree | 1551a1b5d2ce6db371ea4ad3cb47afdb6950725e /doc/source/reference/c-api/array.rst | |
| parent | f212b224c7771ca536f27ddcaf9f4ed930f33f58 (diff) | |
| download | numpy-b3239c67acc85c2bd649548598971ac9b390bad0.tar.gz | |
Dedent list of macros.
Diffstat (limited to 'doc/source/reference/c-api/array.rst')
| -rw-r--r-- | doc/source/reference/c-api/array.rst | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index 901affe8b..26a8f643d 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -1540,19 +1540,6 @@ 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 ^^^^^^^^^^^^^ @@ -2849,6 +2836,17 @@ 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: +.. + dedent the enumeration of flags to avoid missing references sphinx warnings + +.. 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`, |