Skip to content

Commit

Permalink
DOC: Fix incorrect rst markups of c function directives
Browse files Browse the repository at this point in the history
Fixed the first one in the list at numpy#13114 (comment).

[skip cirrus] [skip azp] [skip actions]
  • Loading branch information
koyuki7w committed Mar 6, 2024
1 parent 341ef66 commit 0170958
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/source/reference/c-api/array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -764,18 +764,22 @@ cannot not be accessed directly.
DTypes. These accessors were all added in 2.0.
.. c:function:: PyObject *PyDataType_METADATA(PyArray_Descr *descr)
The Metadata attached to a dtype, either ``NULL`` or a dictionary.
.. c:function:: PyObject *PyDataType_NAMES(PyArray_Descr *descr)
``NULL`` or a list of structured field names attached to a dtype,
this list should not be mutated, NumPy may change the way fields are
stored in the future.
.. c:function:: PyObject *PyDataType_FIELDS(PyArray_Descr *descr)
``NULL``, ``None``, or a dict of structured dtype fields, this dict must
not be mutated, NumPy may change the way fields are stored in the future.
.. c:function:: NpyAuxData *PyDataType_C_METADATA(PyArray_Descr *descr)
C-metadata object attached to a descriptor. This accessor should not
be needed usually. The C-Metadata field does provide access to the
datetime/timedelta time unit information.
Expand Down

0 comments on commit 0170958

Please sign in to comment.