Skip to content

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

Merged
iritkatriel merged 4 commits into
python:mainfrom
iritkatriel:frames-doc
Jun 26, 2024
Merged

gh-119786: move frames documentation to InternalDocs and add details#121009
iritkatriel merged 4 commits into
python:mainfrom
iritkatriel:frames-doc

Conversation

@iritkatriel

@iritkatrieliritkatriel commented Jun 25, 2024

Copy link
Copy Markdown
Member

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

@markshannonmarkshannon 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.

I've a few suggestions.

Also, FYI:

Comment threadInternalDocs/frames.md Outdated

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

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.

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

Copy link
Copy Markdown
MemberAuthor

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.

Comment threadInternalDocs/frames.md Outdated
Comment threadInternalDocs/frames.md Outdated
Comment threadInternalDocs/frames.md Outdated
@markshannon

Copy link
Copy Markdown
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?

@markshannonmarkshannon 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.

Thanks

@iritkatriel
iritkatriel merged commit c878767 into python:mainJun 26, 2024
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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirinterpreter-core(Objects, Python, Grammar, and Parser dirs)skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@iritkatriel@markshannon