GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-119786: move frames documentation to InternalDocs and add details by iritkatriel · Pull Request #121009 · python/cpython

Conversation

@iritkatriel

@iritkatriel iritkatriel commented Jun 25, 2024 •
edited by bedevere-app Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member
  • Issue: create an internals documentation folder in the cpython repo #119786

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@iritkatriel
pythongh-119786: move frames documentation to InternalDocs and add de…
ba933ea 
…tails
@iritkatriel iritkatriel added docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) labels Jun 25, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Jun 25, 2024
create an internals documentation folder in the cpython repo #119786
Closed
@bedevere-app bedevere-app Bot added the awaiting core review label Jun 25, 2024
@iritkatriel
Merge remote-tracking branch 'upstream/main' into frames-doc
30797fe
@iritkatriel iritkatriel added the skip news label Jun 25, 2024
@iritkatriel
iritkatriel requested a review from markshannon June 25, 2024 18:01
markshannon
markshannon reviewed Jun 26, 2024
View reviewed changes

@markshannon markshannon left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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:

  • f_globals and f_builtins are likely to be removed soon faster-cpython/ideas#661
  • We may even move to a two-stack approach faster-cpython/ideas#675

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread InternalDocs/frames.md Outdated

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

@markshannon markshannon Jun 26, 2024

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@iritkatriel iritkatriel Jun 26, 2024

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread InternalDocs/frames.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread InternalDocs/frames.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread InternalDocs/frames.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
@markshannon

markshannon commented Jun 26, 2024

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?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
iritkatriel added 2 commits June 26, 2024 11:16
@iritkatriel
review comments
56c223d
@iritkatriel
remove linkage section
26fd907
markshannon
markshannon approved these changes Jun 26, 2024
View reviewed changes

@markshannon markshannon left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting core review labels Jun 26, 2024
@iritkatriel
iritkatriel merged commit c878767 into python:main Jun 26, 2024
@bedevere-app bedevere-app Bot removed the awaiting merge label Jun 26, 2024
mrahtz pushed a commit to mrahtz/cpython that referenced this pull request Jun 30, 2024
@iritkatriel @mrahtz
pythongh-119786: move frames documentation to InternalDocs and add de…
647f5a8 
…tails (python#121009)
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@iritkatriel @estyxx
pythongh-119786: move frames documentation to InternalDocs and add de…
33dedab 
…tails (python#121009)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markshannon markshannon markshannon approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@iritkatriel @markshannon
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.