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

gh-97909 : PyMemberDef members are not marked up #98473

Merged
merged 4 commits into from
Oct 24, 2022
Merged

gh-97909 : PyMemberDef members are not marked up #98473

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
199c414
Updated the members of PyMemberDef
Johnny11502 Oct 20, 2022
acdc0bc
Updated members of PyMemberDef
Johnny11502 Oct 20, 2022
474b2a0
Add doc for PyMemberDef.name
encukou Oct 24, 2022
3d4b2f4
Remove trailing whitespace from the suggestion
encukou Oct 24, 2022
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
42 changes: 21 additions & 21 deletions Doc/c-api/structures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,27 +406,27 @@ Accessing attributes of extension types
Structure which describes an attribute of a type which corresponds to a C
struct member. Its fields are:

+------------------+---------------+-------------------------------+
| Field | C Type | Meaning |
+==================+===============+===============================+
| :attr:`name` | const char \* | name of the member |
+------------------+---------------+-------------------------------+
| :attr:`!type` | int | the type of the member in the |
| | | C struct |
+------------------+---------------+-------------------------------+
| :attr:`offset` | Py_ssize_t | the offset in bytes that the |
| | | member is located on the |
| | | type's object struct |
+------------------+---------------+-------------------------------+
| :attr:`flags` | int | flag bits indicating if the |
| | | field should be read-only or |
| | | writable |
+------------------+---------------+-------------------------------+
| :attr:`doc` | const char \* | points to the contents of the |
| | | docstring |
+------------------+---------------+-------------------------------+
.. c:member:: const char* PyMemberDef.name

Name of the member

.. c:member:: int PyMemberDef.type

The type of the member in the C struct.

.. c:member:: Py_ssize_t PyMemberDef.offset

The offset in bytes that the member is located on the type’s object struct.

.. c:member:: int PyMemberDef.flags

Flag bits indicating if the field should be read-only or writable.

.. c:member:: const char* PyMemberDef.doc

Points to the contents of the docstring.

:attr:`!type` can be one of many ``T_`` macros corresponding to various C
:c:member:`PyMemberDef.type` can be one of many ``T_`` macros corresponding to various C
types. When the member is accessed in Python, it will be converted to the
equivalent Python type.

Expand Down Expand Up @@ -460,7 +460,7 @@ Accessing attributes of extension types
handles use of the :keyword:`del` statement on that attribute more correctly
than :c:macro:`T_OBJECT`.

:attr:`flags` can be ``0`` for write and read access or :c:macro:`READONLY` for
:c:member:`PyMemberDef.flags` can be ``0`` for write and read access or :c:macro:`READONLY` for
read-only access. Using :c:macro:`T_STRING` for :attr:`type` implies
:c:macro:`READONLY`. :c:macro:`T_STRING` data is interpreted as UTF-8.
Only :c:macro:`T_OBJECT` and :c:macro:`T_OBJECT_EX`
Expand Down