diff options
author | Chiara Marmo <marmochiaskl@gmail.com> | 2021-09-30 20:34:54 +0200 |
---|---|---|
committer | Chiara Marmo <marmochiaskl@gmail.com> | 2021-09-30 20:34:54 +0200 |
commit | 1f6b7837368622eaf856e6535af3997cf36db9a0 (patch) | |
tree | cf6e5e1380f97fa6aa5a3bb828040036be38480c | |
parent | 7ef57aa3879ffc225c1f9918743382348ac3336d (diff) | |
download | numpy-1f6b7837368622eaf856e6535af3997cf36db9a0.tar.gz |
Add comments to prevent revert.
-rw-r--r-- | doc/source/reference/c-api/array.rst | 12 | ||||
-rw-r--r-- | doc/source/reference/c-api/types-and-structures.rst | 9 |
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index 36e976ddb..6a135fd71 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -519,6 +519,9 @@ From other objects :c:data:`NPY_ARRAY_CARRAY` +.. + dedented to allow internal linking, pending a refactoring + .. c:macro:: NPY_ARRAY_IN_ARRAY :c:data:`NPY_ARRAY_C_CONTIGUOUS` \| :c:data:`NPY_ARRAY_ALIGNED` @@ -542,6 +545,9 @@ From other objects :c:data:`NPY_ARRAY_F_CONTIGUOUS` \| :c:data:`NPY_ARRAY_WRITEABLE` \| :c:data:`NPY_ARRAY_ALIGNED` +.. + dedented to allow internal linking, pending a refactoring + .. c:macro:: NPY_ARRAY_INOUT_ARRAY :c:data:`NPY_ARRAY_C_CONTIGUOUS` \| :c:data:`NPY_ARRAY_WRITEABLE` \| @@ -584,6 +590,9 @@ From other objects did not have the _ARRAY_ macro namespace in them. That form of the constant names is deprecated in 1.7. +.. + dedented to allow internal linking, pending a refactoring + .. c:macro:: NPY_ARRAY_NOTSWAPPED Make sure the returned array has a data-type descriptor that is in @@ -600,6 +609,9 @@ From other objects :c:data:`NPY_ARRAY_ALIGNED` \| :c:data:`NPY_ARRAY_WRITEABLE` \| :c:data:`NPY_ARRAY_NOTSWAPPED` +.. + dedented to allow internal linking, pending a refactoring + .. c:macro:: NPY_ARRAY_ELEMENTSTRIDES Make sure the returned array has strides that are multiples of the diff --git a/doc/source/reference/c-api/types-and-structures.rst b/doc/source/reference/c-api/types-and-structures.rst index 21cac636b..0a684d6f5 100644 --- a/doc/source/reference/c-api/types-and-structures.rst +++ b/doc/source/reference/c-api/types-and-structures.rst @@ -286,6 +286,9 @@ PyArrayDescr_Type and PyArray_Descr array like behavior. Each bit in this member is a flag which are named as: +.. + dedented to allow internal linking, pending a refactoring + .. c:macro:: NPY_ITEM_REFCOUNT Indicates that items of this data-type must be reference @@ -295,6 +298,9 @@ PyArrayDescr_Type and PyArray_Descr Same as :c:data:`NPY_ITEM_REFCOUNT`. +.. + dedented to allow internal linking, pending a refactoring + .. c:macro:: NPY_LIST_PICKLE Indicates arrays of this data-type must be converted to a list @@ -989,6 +995,9 @@ PyUFunc_Type and PyUFuncObject For each distinct core dimension, a set of ``UFUNC_CORE_DIM*`` flags +.. + dedented to allow internal linking, pending a refactoring + .. c:macro:: UFUNC_CORE_DIM_CAN_IGNORE if the dim name ends in ``?`` |