gh-102304: Enhance Simple ABI doc #105351
Conversation
Makefile.pre.in
Outdated
| @@ -1314,6 +1314,7 @@ regen-limited-abi: all | |||
| # - Lib/test/test_stable_abi_ctypes.py | |||
| # - Modules/_testcapi_feature_macros.inc | |||
| # - PC/python3dll.c | |||
| # https://devguide.python.org/developer-workflow/c-api/#adding-a-new-definition-to-the-limited-api | |||
There was a problem hiding this comment.
Could you remove the list of files, which will become outdated in time?
There was a problem hiding this comment.
Or: why is this needed? I can keep it up to date if there's a need for it.
There was a problem hiding this comment.
I like to know which files are generated by make by reading the Makefile. I would prefer to not have to open a web browser. Moreover, the linked URL doesn't list which files are modified.
There was a problem hiding this comment.
The commnand to list them is ./python Tools/build/stable_abi.py --list . (and with #105355 the dot will be unnecessary.)
Is that enough? If not I can add a check to make sure Makefile is up to date.
There was a problem hiding this comment.
You seem to worry more than me that such comment can be outdated. I can survive without this comment, so I just removed it. I would like to backport my C API doc change to 3.12 to unblock PR #105352 fix.
So it's no longer needed to maintain it.
|
Thanks! |
(cherry picked from commit 0202aa0)
|
Thanks for the review. I wrote a new PR for 3.12 which combines the 2 doc changes: PR #105371. |
…5345) (#105371) * gh-102304: doc: Add links to Stable ABI and Limited C API (#105345) * Add "limited-c-api" and "stable-api" references. * Rename "stable-abi-list" reference to "limited-api-list". * Makefile: Document files regenerated by "make regen-limited-abi" * Remove first empty line in generated files: - Lib/test/test_stable_abi_ctypes.py - PC/python3dll.c (cherry picked from commit bae415a) * gh-102304: Fix up Simple ABI doc (GH-105351) (cherry picked from commit 0202aa0)
python#105345) (python#105371) * pythongh-102304: doc: Add links to Stable ABI and Limited C API (python#105345) * Add "limited-c-api" and "stable-api" references. * Rename "stable-abi-list" reference to "limited-api-list". * Makefile: Document files regenerated by "make regen-limited-abi" * Remove first empty line in generated files: - Lib/test/test_stable_abi_ctypes.py - PC/python3dll.c (cherry picked from commit bae415a) * pythongh-102304: Fix up Simple ABI doc (pythonGH-105351) (cherry picked from commit 0202aa0) (cherry picked from commit 82ab13c)
python#105345) (python#105371) * pythongh-102304: doc: Add links to Stable ABI and Limited C API (python#105345) * Add "limited-c-api" and "stable-api" references. * Rename "stable-abi-list" reference to "limited-api-list". * Makefile: Document files regenerated by "make regen-limited-abi" * Remove first empty line in generated files: - Lib/test/test_stable_abi_ctypes.py - PC/python3dll.c (cherry picked from commit bae415a) * pythongh-102304: Fix up Simple ABI doc (pythonGH-105351) (cherry picked from commit 0202aa0) (cherry picked from commit 82ab13c)
📚 Documentation preview 📚: https://cpython-previews--105351.org.readthedocs.build/