gh-119786: move interpreter doc from devguide to InternalDocs #125715
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iritkatriel
force-pushed
the
interpreter-doc
branch
from
7148b3c
to
d65ee0f
Compare
iritkatriel
requested review from
willingc,
JacobCoffee,
AlexWaygood,
markshannon and
brandtbucher
willingc
approved these changes
Oct 19, 2024
There was a problem hiding this comment.
Thanks @iritkatriel. I love that the internals docs are next to the code 😄
AlexWaygood
reviewed
Oct 19, 2024
InternalDocs/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), |
There was a problem hiding this comment.
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), |
There was a problem hiding this comment.
I guess I could also use relative links to the code (like ../Python/bytecodes.c).
There was a problem hiding this comment.
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:
AlexWaygood
approved these changes
Oct 19, 2024
JacobCoffee
approved these changes
Oct 20, 2024
Co-authored-by: Jacob Coffee <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
|
🚢 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reorganised index:
https://github.com/python/cpython/blob/7cb14417f5609f75ab484bc81885930158317336/InternalDocs/README.md
Interpreter doc:
https://github.com/python/cpython/blob/7cb14417f5609f75ab484bc81885930158317336/InternalDocs/interpreter.md