mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 10:50:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

gh-97908: CAPI docs: Remove repeated struct names from member docs (GH-100054)

Browse source 
And add raw HTML fragments to keep old links working.
This commit is contained in:
Petr Viktorin 2023-05-29 13:54:14 +02:00 • committed by GitHub
parent bfd20d257e
commit 1668b41dc4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/c-api/structures.rst
View file

@ -395,7 +395,7 @@ Accessing attributes of extension types
The string should be static, no copy is made of it. The string should be static, no copy is made of it.
.. c:member:: Py_ssize_t PyMemberDef.offset .. c:member:: Py_ssize_t offset
The offset in bytes that the member is located on the type’s object struct. The offset in bytes that the member is located on the type’s object struct.
@ -625,23 +625,23 @@ Defining Getters and Setters
Structure to define property-like access for a type. See also description of Structure to define property-like access for a type. See also description of
the :c:member:`PyTypeObject.tp_getset` slot. the :c:member:`PyTypeObject.tp_getset` slot.
.. c:member:: const char* PyGetSetDef.name .. c:member:: const char* name
attribute name attribute name
.. c:member:: getter PyGetSetDef.get .. c:member:: getter get
C function to get the attribute. C function to get the attribute.
.. c:member:: setter PyGetSetDef.set .. c:member:: setter set
Optional C function to set or delete the attribute, if omitted the attribute is readonly. Optional C function to set or delete the attribute, if omitted the attribute is readonly.
.. c:member:: const char* PyGetSetDef.doc .. c:member:: const char* doc
optional docstring optional docstring
.. c:member:: void* PyGetSetDef.closure .. c:member:: void* closure
Optional function pointer, providing additional data for getter and setter. Optional function pointer, providing additional data for getter and setter.

19
Doc/c-api/type.rst
View file

@ -349,6 +349,15 @@ The following functions and structs are used to create
:c:member:`~PyTypeObject.tp_new` is deprecated and in Python 3.14+ it :c:member:`~PyTypeObject.tp_new` is deprecated and in Python 3.14+ it
will be no longer allowed. will be no longer allowed.
.. raw:: html
<!-- Keep old URL fragments working (see gh-97908) -->
<span id='c.PyType_Spec.PyType_Spec.name'></span>
<span id='c.PyType_Spec.PyType_Spec.basicsize'></span>
<span id='c.PyType_Spec.PyType_Spec.itemsize'></span>
<span id='c.PyType_Spec.PyType_Spec.flags'></span>
<span id='c.PyType_Spec.PyType_Spec.slots'></span>
.. c:type:: PyType_Spec .. c:type:: PyType_Spec
Structure defining a type's behavior. Structure defining a type's behavior.
@ -410,12 +419,18 @@ The following functions and structs are used to create
Each slot ID should be specified at most once. Each slot ID should be specified at most once.
.. raw:: html
<!-- Keep old URL fragments working (see gh-97908) -->
<span id='c.PyType_Slot.PyType_Slot.slot'></span>
<span id='c.PyType_Slot.PyType_Slot.pfunc'></span>
.. c:type:: PyType_Slot .. c:type:: PyType_Slot
Structure defining optional functionality of a type, containing a slot ID Structure defining optional functionality of a type, containing a slot ID
and a value pointer. and a value pointer.
.. c:member:: int PyType_Slot.slot .. c:member:: int slot
A slot ID. A slot ID.
@ -459,7 +474,7 @@ The following functions and structs are used to create
:c:member:`~PyBufferProcs.bf_releasebuffer` are now available :c:member:`~PyBufferProcs.bf_releasebuffer` are now available
under the limited API. under the limited API.
.. c:member:: void *PyType_Slot.pfunc .. c:member:: void *pfunc
The desired value of the slot. In most cases, this is a pointer The desired value of the slot. In most cases, this is a pointer
to a function. to a function.