Skip to content

Commit

Permalink
gh-97909: Mark up members of PyMemberDef (GH-98473)
Browse files Browse the repository at this point in the history
Co-authored-by: T <[email protected]>
  • Loading branch information
Johnny11502 and kwsp authored Oct 24, 2022
1 parent e19c2b9 commit c237076
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions Doc/c-api/structures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -387,27 +387,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 types 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 @@ -441,7 +441,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

0 comments on commit c237076

Please sign in to comment.