Skip to content

gh-97908: CAPI docs: Remove repeated struct names from member docs #100054

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

Merged
encukou merged 7 commits into from
May 29, 2023
Merged

gh-97908: CAPI docs: Remove repeated struct names from member docs #100054

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
493ff87
TMP: Fail docs build on repeated name components
encukou Dec 6, 2022
e2867fd
Remove duplicate struct names from member docs
encukou Dec 6, 2022
14c2ae7
Add raw HTML fragments to keep old links working
encukou Dec 6, 2022
26e095e
Remove hack to find repeated struct names
encukou Dec 6, 2022
afab871
Merge branch 'main' into struct-name-repeats
encukou Dec 6, 2022
cc57955
Don't add "old" fragments for PyMemberDef and PyGetSetDef
encukou Dec 6, 2022
6b5824e
Merge branch 'main' of https://github.com/python/cpython into struct-…
encukou May 25, 2023
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
Prev Previous commit
Next Next commit
Add raw HTML fragments to keep old links working
  • Loading branch information
@encukou
encukou committed Dec 6, 2022
commit 14c2ae7a66b3698ae19e21769a57fd8477ecc061
18 changes: 18 additions & 0 deletions Doc/c-api/structures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,15 @@ definition with the same method name.
Accessing attributes of extension types
---------------------------------------

.. raw:: html

<!-- Keep old URL fragments working (see gh-97908) -->
<span id='c.PyMemberDef.PyMemberDef.name'></span>
<span id='c.PyMemberDef.PyMemberDef.offset'></span>
<span id='c.PyMemberDef.PyMemberDef.type'></span>
<span id='c.PyMemberDef.PyMemberDef.flags'></span>
<span id='c.PyMemberDef.PyMemberDef.doc'></span>

.. c:type:: PyMemberDef

Structure which describes an attribute of a type which corresponds to a C
Expand Down Expand Up @@ -603,6 +612,15 @@ Macro name C type Python type
Defining Getters and Setters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. raw:: html

<!-- Keep old URL fragments working (see gh-97908) -->
<span id='c.PyGetSetDef.PyGetSetDef.name'></span>
<span id='c.PyGetSetDef.PyGetSetDef.get'></span>
<span id='c.PyGetSetDef.PyGetSetDef.set'></span>
<span id='c.PyGetSetDef.PyGetSetDef.docstring'></span>
<span id='c.PyGetSetDef.PyGetSetDef.closure'></span>

.. c:type:: PyGetSetDef

Structure to define property-like access for a type. See also description of
Expand Down
15 changes: 15 additions & 0 deletions Doc/c-api/type.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,15 @@ The following functions and structs are used to create
base classes provided in *Py_tp_base[s]* slots.
Previously, only :class:`type` instances were returned.

.. 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

Structure defining a type's behavior.
Expand Down Expand Up @@ -347,6 +356,12 @@ The following functions and structs are used to create

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

Structure defining optional functionality of a type, containing a slot ID
Expand Down