Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Fix incorrect rst markups of c function directives #25947

Merged
merged 1 commit into from
Mar 6, 2024
Merged

DOC: Fix incorrect rst markups of c function directives #25947

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/source/reference/c-api/array.rst
View file
Open in desktop
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
Loading