gh-141004: Document unstable executable kind macros in pyframe.h#143490
gh-141004: Document unstable executable kind macros in pyframe.h#143490Yashp002 wants to merge 12 commits into
pyframe.h#143490Conversation
|
These are rather useless without docs for |
Sorry, something went wrong.
|
@encukou ok, makes sense. I'll add the documentation for PyUnstable_ExecutableKinds and link these macros to it. Thanks :) |
Sorry, something went wrong.
ZeroIntensity
left a comment
There was a problem hiding this comment.
You need to update ignored_c_api.txt here too.
Sorry, something went wrong.
|
test_asyncio.test_sendfile port conflict - unrelated to docs. |
Sorry, something went wrong.
|
We don't need those tests to run at all really, we can (I think) exclude the ignore file from triggering the Edit: See #143583. |
Sorry, something went wrong.
Can the same be said for #143492 |
Sorry, something went wrong.
|
@StanFromIreland @encukou Here too, do I need to make any more changes? |
Sorry, something went wrong.
|
This part is not clear to me:
I assume “frame” refers to Once the docs say what the function is for and how to use it, there are some presentation issues to fix up: There are now two descriptions for |
Sorry, something went wrong.
|
@encukou Since PyUnstable_EXECUTABLE_KIND_SKIP has only a couple words, should I just keep the list-table description and remove the one below completely? Also, Yes the frame refers to PyFrameObject and I'll be adding a sentence below saying "The frame should be skipped by tools. Should i go ahead with above mentioned changes? |
Sorry, something went wrong.
Yes. But switch to the Example code would be very helpful, yes. Please test that it works, though. |
Sorry, something went wrong.
|
@encukou could u check if these changes are satisfactory |
Sorry, something went wrong.
|
How did you check that the example code works? |
Sorry, something went wrong.
|
@encukou modified: Doc/c-api/frame.rst the tests seem to pass and the build works |
Sorry, something went wrong.
|
This PR is stale because it has been open for 30 days with no activity. |
Sorry, something went wrong.

gh-141004: Document unstable executable kind macros in
pyframe.hThis PR documents the
PyUnstable_EXECUTABLE_KIND_*macros and thePyUnstable_ExecutableKindsarray inDoc/c-api/frame.rst. These were listed as undocumented in the parent issue.📚 Documentation preview 📚: https://cpython-previews--143490.org.readthedocs.build/