Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-119786: move frames documentation to InternalDocs and add details #121009

Merged
merged 4 commits into from
Jun 26, 2024

Conversation

iritkatriel
Copy link
Member

@iritkatriel iritkatriel commented Jun 25, 2024

@iritkatriel iritkatriel added docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) labels Jun 25, 2024
Copy link
Member

@markshannon markshannon left a comment

Choose a reason for hiding this comment

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

I've a few suggestions.

Also, FYI:


* Local variables (including arguments, cells and free variables)
* Evaluation stack
* Evaluation stack and instruction pointer
Copy link
Member

Choose a reason for hiding this comment

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

I don't think the instruction pointer belongs here (at least not conceptually).
I would add it to specials/linkage

Copy link
Member Author

Choose a reason for hiding this comment

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

How about I change this line to
Execution state: evaluation stack, instruction pointer ?

It feels like instruction pointer is internal to the frame's working, rather than linking to external frames or objects.

InternalDocs/frames.md Outdated Show resolved Hide resolved
InternalDocs/frames.md Outdated Show resolved Hide resolved
InternalDocs/frames.md Outdated Show resolved Hide resolved
@markshannon
Copy link
Member

I think it would make sense to merge the "specials" and "linkage" sections. The only real "linkage" is the previous pointer.

So, maybe replace "specials and linkage" with "specials", and when specifically referring to "linkage", say previous poointer?

Copy link
Member

@markshannon markshannon left a comment

Choose a reason for hiding this comment

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

Thanks

@iritkatriel iritkatriel merged commit c878767 into python:main Jun 26, 2024
33 checks passed
mrahtz pushed a commit to mrahtz/cpython that referenced this pull request Jun 30, 2024
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull request Jul 11, 2024
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants