Repository navigation
gh-159808: Sync documented C API structs with their headers - #159812
Open
ngoldbaum wants to merge 2 commits into
Open
ngoldbaum wants to merge 2 commits into
ngoldbaum wants to merge 2 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
ngoldbaum
requested review from
FFY00,
ZeroIntensity,
brettcannon,
ericsnowcurrently,
ncoghlan and
warsaw
as code owners
October 19, 2026 23:26
Copy link
Copy Markdown
Documentation build overview3 files changed ± c-api/import.html ± c-api/slots.html ± extending/newtypes.html |
Sorry, something went wrong.
brettcannon
removed their request for review
October 19, 2026 23:34
encukou
reviewed
Oct 20, 2026
Comment thread
Doc/c-api/import.rst
| }; | ||
| is: | ||
|
|
||
| .. literalinclude:: ../../Include/cpython/import.h |
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Could you add a comment to import.h before the struct, warning that this is included in public docs?
Sorry, something went wrong.
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
Reviewers
2 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.
Fixes #159808.
@encukou suggested to just delete the PyTypeObject definition from the docs but I wasn't quite brave enough to do that. I could also see valid reasons for wanting to know what's in that type and just generally would prefer not to break old docs links.
Instead I added a comment to the end of the file in Doc/includes to more forcefully hint that private fields shouldn't be documented. The comment shouldn't show up in the built docs.