Closed
Description
Sphinx would like to remove support for the pre-v3 C domain syntax. We have confirmed that the Linux kernel is no longer using it, so Python is the only project we are blocked on.
I have a branch where I've done the work, but it is a large number of files affected (~50) and the majority of the C-API documentation. The changes are almost all mechanical search-and-replace, but there are a few where I've had to use judgement.
Questions:
- Is this change welcome?
- How should I proceed with PRs? One per data type, per file, etc?
- I would want to backport these changes to 3.10/3.11 (to allow future docs backports without conflicts), does anybody have objections?
- Does anybody have other concerns?
cc: @vstinner @serhiy-storchaka @encukou @erlend-aasland @JelleZijlstra @hugovk (Selection of C-API/documentation people, if I've missed anyone please mention them).
A
Tasks
- gh-93738: Documentation C syntax (:c:data:
0
->0
) #97771 - gh-93738: Documentation C syntax (:c:type:
Py_UNICODE*
-> :c:expr:Py_UNICODE*
) #97784 - gh-93738: Documentation C syntax (:c:type:
PyUnicodeObject*
-> :c:expr:PyUnicodeObject*
) #97783 - gh-93738: Documentation C syntax (:c:type:
PyBytesObject*
-> :c:expr:PyBytesObject*
) #97782 - gh-93738: Documentation C syntax (:c:type:
PyTupleObject*
-> :c:expr:PyTupleObject*
) #97780 - gh-93738: Documentation C syntax (:c:data:
view->obj
-> :c:expr:view->obj
) #97773 - gh-93738: Documentation C syntax (:c:type:
FILE
-> :c:expr:FILE
) #97769 - gh-93738: Documentation C syntax (:c:type:
TYPE
-> :c:expr:TYPE
) #97770 - gh-93738: Documentation C syntax (:c:type:
PyInterpreterState *
-> :c:expr:PyInterpreterState *
) #97777 - gh-93738: Documentation C syntax (:c:type:
PyObject
-> :c:expr:PyObject
) #97776 - gh-93738: Documentation C syntax (:c:type: to :c:expr:, misc. cases) #97775
- gh-93738: Documentation C syntax (:c:type:
PyTypeObject*
-> :c:expr:PyTypeObject*
) #97778 - gh-93738: Documentation C syntax (Use
c:struct
) #97772 - gh-93738: Documentation C syntax (Function glob patterns -> literal markup) #97774
- gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) #97768
- gh-93738: Disallow pre-v3 syntax in the C domain #97962
Metadata
Metadata
Assignees
Labels
only security fixesonly security fixesonly security fixesonly security fixesonly security fixesonly security fixesDocumentation in the Doc dirDocumentation in the Doc dir
Projects
Status
Done