gh-152105: Remove docs snippet that uses internal C API - #155122
Open
encukou wants to merge 1 commit into
Open
Conversation
Follow-up to pythonGH-143490. `_PyInterpreterFrame.f_executable` and `PyStackRef_AsPyObjectBorrow` are undocumented and only available in the internal API. Docs should not suggest using them, even if `PyUnstable_ExecutableKinds` is unusable without them.
Documentation build overview
|
ZeroIntensity
approved these changes
Aug 3, 2026
| return PyUnstable_EXECUTABLE_KIND_SKIP; | ||
| } | ||
| Note that reading the executable kind from a frame is currently only | ||
| possible with undocumented internal API. |
Member
There was a problem hiding this comment.
Nit: little grammatical issue, either:
Suggested change
| possible with undocumented internal API. | |
| possible with undocumented internal APIs. |
or
Suggested change
| possible with undocumented internal API. | |
| possible with an undocumented internal API. |
Member
There was a problem hiding this comment.
"API" is sometimes a non-count noun. We're not consistent with it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to GH-143490 (see this comment).
_PyInterpreterFrame.f_executableandPyStackRef_AsPyObjectBorroware undocumented and only available in the internal API. Docs should not suggest using them, even ifPyUnstable_ExecutableKindsis unusable without them.This is a backportable docs PR; for 3.16 let's remove the API unless someone explains things. (I'll send the PR after this is merged.)
PyUnstable_ExecutableKindsis useless #152105