Skip to content

Commit

Permalink
Merge pull request #17527 from takanori-pskq/i13114-fix-npy-bool
Browse files Browse the repository at this point in the history
DOC: Fix Boolean types in C functions
  • Loading branch information
charris committed Oct 10, 2020
2 parents 2866c83 + 9c2ae9e commit f0171ba
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions doc/source/reference/c-api/array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -999,7 +999,7 @@ argument must be a :c:type:`PyObject *<PyObject>` that can be directly interpret
Evaluates true if the data area of the ndarray *m* is **not** in
machine byte-order according to the array's data-type descriptor.
.. c:function:: Bool PyArray_EquivTypes( \
.. c:function:: npy_bool PyArray_EquivTypes( \
PyArray_Descr* type1, PyArray_Descr* type2)
Return :c:data:`NPY_TRUE` if *type1* and *type2* actually represent
Expand All @@ -1008,13 +1008,13 @@ argument must be a :c:type:`PyObject *<PyObject>` that can be directly interpret
:c:data:`NPY_LONG` and :c:data:`NPY_INT` are equivalent. Otherwise
return :c:data:`NPY_FALSE`.
.. c:function:: Bool PyArray_EquivArrTypes( \
.. c:function:: npy_bool PyArray_EquivArrTypes( \
PyArrayObject* a1, PyArrayObject * a2)
Return :c:data:`NPY_TRUE` if *a1* and *a2* are arrays with equivalent
types for this platform.
.. c:function:: Bool PyArray_EquivTypenums(int typenum1, int typenum2)
.. c:function:: npy_bool PyArray_EquivTypenums(int typenum1, int typenum2)
Special case of :c:func:`PyArray_EquivTypes` (...) that does not accept
flexible data types but may be easier to call.
Expand Down Expand Up @@ -1650,7 +1650,7 @@ Conversion
destination must be an integer multiple of the number of elements
in *val*.
.. c:function:: PyObject* PyArray_Byteswap(PyArrayObject* self, Bool inplace)
.. c:function:: PyObject* PyArray_Byteswap(PyArrayObject* self, npy_bool inplace)
Equivalent to :meth:`ndarray.byteswap<numpy.ndarray.byteswap>` (*self*, *inplace*). Return an array
whose data area is byteswapped. If *inplace* is non-zero, then do
Expand Down Expand Up @@ -2309,7 +2309,7 @@ Array Functions
Other functions
^^^^^^^^^^^^^^^
.. c:function:: Bool PyArray_CheckStrides( \
.. c:function:: npy_bool PyArray_CheckStrides( \
int elsize, int nd, npy_intp numbytes, npy_intp const* dims, \
npy_intp const* newstrides)
Expand Down Expand Up @@ -2959,7 +2959,7 @@ to.
:c:data:`NPY_MAXDIMS` which is interpreted correctly by the C-API
functions that take axis arguments.
.. c:function:: int PyArray_BoolConverter(PyObject* obj, Bool* value)
.. c:function:: int PyArray_BoolConverter(PyObject* obj, npy_bool* value)
Convert any Python object, *obj*, to :c:data:`NPY_TRUE` or
:c:data:`NPY_FALSE`, and place the result in *value*.
Expand Down
6 changes: 3 additions & 3 deletions doc/source/reference/c-api/types-and-structures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ PyArrayDescr_Type and PyArray_Descr
This function should be called without holding the Python GIL, and
has to grab it for error reporting.
.. c:member:: Bool nonzero(void* data, void* arr)
.. c:member:: npy_bool nonzero(void* data, void* arr)
A pointer to a function that returns TRUE if the item of
``arr`` pointed to by ``data`` is nonzero. This function can
Expand Down Expand Up @@ -1012,7 +1012,7 @@ PyArrayIter_Type and PyArrayIterObject
npy_intp factors[NPY_MAXDIMS];
PyArrayObject *ao;
char *dataptr;
Bool contiguous;
npy_bool contiguous;
} PyArrayIterObject;
.. c:member:: int nd_m1
Expand Down Expand Up @@ -1062,7 +1062,7 @@ PyArrayIter_Type and PyArrayIterObject
This member points to an element in the ndarray indicated by the
index.
.. c:member:: Bool contiguous
.. c:member:: npy_bool contiguous
This flag is true if the underlying array is
:c:data:`NPY_ARRAY_C_CONTIGUOUS`. It is used to simplify
Expand Down

0 comments on commit f0171ba

Please sign in to comment.