Skip to content

Commit 00b6745

Browse files
authored
gh-97909: PyMemberDef & PyGetSetDef members are not marked up (GH-98810)
1 parent a60ddd3 commit 00b6745

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

Doc/c-api/structures.rst

+19-17
Original file line numberDiff line numberDiff line change
@@ -485,23 +485,25 @@ Accessing attributes of extension types
485485
Structure to define property-like access for a type. See also description of
486486
the :c:member:`PyTypeObject.tp_getset` slot.
487487
488-
+-------------+------------------+-----------------------------------+
489-
| Field | C Type | Meaning |
490-
+=============+==================+===================================+
491-
| name | const char \* | attribute name |
492-
+-------------+------------------+-----------------------------------+
493-
| get | getter | C function to get the attribute |
494-
+-------------+------------------+-----------------------------------+
495-
| set | setter | optional C function to set or |
496-
| | | delete the attribute, if omitted |
497-
| | | the attribute is readonly |
498-
+-------------+------------------+-----------------------------------+
499-
| doc | const char \* | optional docstring |
500-
+-------------+------------------+-----------------------------------+
501-
| closure | void \* | optional function pointer, |
502-
| | | providing additional data for |
503-
| | | getter and setter |
504-
+-------------+------------------+-----------------------------------+
488+
.. c:member:: const char* PyGetSetDef.name
489+
490+
attribute name
491+
492+
.. c:member:: getter PyGetSetDef.get
493+
494+
C funtion to get the attribute.
495+
496+
.. c:member:: setter PyGetSetDef.set
497+
498+
Optional C function to set or delete the attribute, if omitted the attribute is readonly.
499+
500+
.. c:member:: const char* PyGetSetDef.doc
501+
502+
optional docstring
503+
504+
.. c:member:: void* PyGetSetDef.closure
505+
506+
Optional function pointer, providing additional data for getter and setter.
505507
506508
The ``get`` function takes one :c:expr:`PyObject*` parameter (the
507509
instance) and a function pointer (the associated ``closure``)::

0 commit comments

Comments
 (0)