◐ Shell
reader mode source ↗
Skip to content

bpo-46836: Add Doc/c-api/frame.rst#32051

Merged
vstinner merged 5 commits into
python:mainfrom
vstinner:frame_doc
Mar 23, 2022
Merged

bpo-46836: Add Doc/c-api/frame.rst#32051
vstinner merged 5 commits into
python:mainfrom
vstinner:frame_doc

Conversation

@vstinner

@vstinner vstinner commented Mar 22, 2022 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

Reorganize the documentation of the PyFrameObject C API.

https://bugs.python.org/issue46836

@vstinner
bpo-46836: Add Doc/c-api/frame.rst …
58aedac 
Reorganize the documentation of the PyFrameObject C API.
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Mar 22, 2022
@vstinner

vstinner commented Mar 22, 2022

Copy link
Copy Markdown
Member Author

My previous attempt to document PyFrameObject, in 2013: https://bugs.python.org/issue19431

@gvanrossum

gvanrossum commented Mar 22, 2022

Copy link
Copy Markdown
Member

@markshannon ^^

@vstinner vstinner mentioned this pull request Mar 22, 2022
Closed
markshannon
markshannon reviewed Mar 22, 2022
View reviewed changes

@markshannon markshannon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Thanks, it makes sense to more all the Frame API docs to one place.

I'd really like discourage extension code from accessing the internals of the frame, as the integrity of the VM relies on it in subtle ways.

@markshannon

markshannon commented Mar 23, 2022

Copy link
Copy Markdown
Member

@vstinner
I'd like to get at least a minimal version of this merged, so I have somewhere to put the docs for new PyFrame C-API functions.

@markshannon

markshannon commented Mar 23, 2022

Copy link
Copy Markdown
Member

Thanks.

@markshannon markshannon mentioned this pull request Mar 23, 2022
Merged
@vstinner vstinner merged commit b0f886d into python:main Mar 23, 2022
@vstinner vstinner deleted the frame_doc branch March 23, 2022 12:19
@vstinner

vstinner commented Mar 23, 2022

Copy link
Copy Markdown
Member Author

@kumaraditya303: Can you please propose a PR for your changes?

Mark needed this PR for his PR #32055 and so I merged my PR.

I removed the whole section about "public members" since they are confusing. I will propose a second PR to find a way to document them.

@kumaraditya303

kumaraditya303 commented Mar 23, 2022

Copy link
Copy Markdown
Contributor

@kumaraditya303: Can you please propose a PR for your changes?

Sure, seems like github removed my comments as I was still adding suggestions and the PR got merged.

@vstinner vstinner mentioned this pull request May 2, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markshannon markshannon markshannon left review comments

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@vstinner @gvanrossum @markshannon @kumaraditya303 @the-knights-who-say-ni @bedevere-bot