Skip to content

gh-119786: move interpreter doc from devguide to InternalDocs - #125715

Merged
iritkatriel merged 6 commits into
python:mainfrom
iritkatriel:interpreter-doc
Oct 21, 2024
Merged

gh-119786: move interpreter doc from devguide to InternalDocs#125715
iritkatriel merged 6 commits into
python:mainfrom
iritkatriel:interpreter-doc

Conversation

@willingcwillingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @iritkatriel. I love that the internals docs are next to the code 😄

Comment threadInternalDocs/interpreter.md Outdated
Comment on lines +22 to +23
Recall that the [Python Compiler](https://github.com/python/cpython/blob/main/InternalDocs/compiler.md)
produces a [`CodeObject`](https://github.com/python/cpython/blob/main/InternalDocs/code_object.md),

@AlexWaygoodAlexWaygoodOct 19, 2024

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 think you might be able to get away with just this (also applies to a bunch of other links in this PR):

Suggested change
Recall that the [Python Compiler](https://github.com/python/cpython/blob/main/InternalDocs/compiler.md)
produces a [`CodeObject`](https://github.com/python/cpython/blob/main/InternalDocs/code_object.md),
Recall that the [Python Compiler](compiler.md) produces a [`CodeObject`](code_object.md),

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.

I guess I could also use relative links to the code (like ../Python/bytecodes.c).

@AlexWaygoodAlexWaygoodOct 21, 2024

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.

Try it and see how it renders? You can get a good preview of how GitHub will render it by pushing to this PR branch, then clicking this "View file" button here from the "files changed" tab:


image

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

Nice! A couple of minor things I spotted:

Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/interpreter.md Outdated
Comment threadInternalDocs/README.md Outdated
iritkatrieland others added 2 commits October 21, 2024 18:09
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@willingc

Copy link
Copy Markdown
Contributor

🚢

@iritkatriel
iritkatriel merged commit 695814c into python:mainOct 21, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@iritkatriel@willingc@JacobCoffee@AlexWaygood