[Python-checkins] gh-97909: PyMemberDef & PyGetSetDef members are not marked up (GH-98810)

encukou webhook-mailer at python.org
Thu Nov 3 12:57:36 EDT 2022


https://github.com/python/cpython/commit/00b6745f16f8d1ffe8a9974677dbf00657a06805
commit: 00b6745f16f8d1ffe8a9974677dbf00657a06805
branch: main
author: Johnny11502 <113304663+Johnny11502 at users.noreply.github.com>
committer: encukou <encukou at gmail.com>
date: 2022-11-03T17:57:30+01:00
summary:

gh-97909: PyMemberDef & PyGetSetDef members are not marked up (GH-98810)

files:
M Doc/c-api/structures.rst

diff --git a/Doc/c-api/structures.rst b/Doc/c-api/structures.rst
index 183ac144c50d..5a20f07214fd 100644
--- a/Doc/c-api/structures.rst
+++ b/Doc/c-api/structures.rst
@@ -485,23 +485,25 @@ Accessing attributes of extension types
    Structure to define property-like access for a type. See also description of
    the :c:member:`PyTypeObject.tp_getset` slot.
 
-   +-------------+------------------+-----------------------------------+
-   | Field       | C Type           | Meaning                           |
-   +=============+==================+===================================+
-   | name        | const char \*    | attribute name                    |
-   +-------------+------------------+-----------------------------------+
-   | get         | getter           | C function to get the attribute   |
-   +-------------+------------------+-----------------------------------+
-   | set         | setter           | optional C function to set or     |
-   |             |                  | delete the attribute, if omitted  |
-   |             |                  | the attribute is readonly         |
-   +-------------+------------------+-----------------------------------+
-   | doc         | const char \*    | optional docstring                |
-   +-------------+------------------+-----------------------------------+
-   | closure     | void \*          | optional function pointer,        |
-   |             |                  | providing additional data for     |
-   |             |                  | getter and setter                 |
-   +-------------+------------------+-----------------------------------+
+   .. c:member:: const char* PyGetSetDef.name
+
+      attribute name
+
+   .. c:member:: getter PyGetSetDef.get
+
+      C funtion to get the attribute.
+
+   .. c:member:: setter PyGetSetDef.set
+
+      Optional C function to set or delete the attribute, if omitted the attribute is readonly.
+
+   .. c:member:: const char* PyGetSetDef.doc
+
+      optional docstring
+
+   .. c:member:: void* PyGetSetDef.closure
+
+      Optional function pointer, providing additional data for getter and setter.
 
    The ``get`` function takes one :c:expr:`PyObject*` parameter (the
    instance) and a function pointer (the associated ``closure``)::



More information about the Python-checkins mailing list