Start a chapter on 3.11 interpreter internals #1028
Conversation
This commit is just a backup in case my machine crashes.
There was a problem hiding this comment.
Standard reminder: You can apply the suggestions you want in one go with Files changed -> Add to batch -> Commit.
Overall, this was of course very well written, and despite being a relative n00b, there were only a few parts were I was unsure about. My comments, nearly all as suggestions, mostly pertain to:
- Adding/improving the Sphinx syntax, adding links/cross-references/formatting to the appropriate Python files, functions, classes and C APIs,
- Clarifying/rephrasing a few bits that I found unclear, ambiguous or difficult to read
- Fixing a handful of typos and minor grammar/punctuation issues
I must note that the particular choice of line-break style (OSPL) made this a relative joy to review and make suggestions on compared to arbitrary fixed-width hard breaks :)
(And one by HvK) Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
Neither link works: - deepfreeze.py was moved between 3.11 and 3.12 - deepfreeze.c is not in the repo
|
I've just landed this, I need to move on to 3.12 again. :-) (faster-cpython/ideas#539, faster-cpython/ideas#540). |
|
Thank you for writing this! It's great to have a resource on what the code is meant to do – which you can't always tell from the code itself, especially when debugging an issue :) Also thanks for leaving the TODOs in to show where the gaps are. |
|
The lesser-spotted "explanation" part of Diátaxis :)
|
|
There actually is a todo extensionsion built into Sphinx, which has some handy features to mark todos, list them and control whether and how they are shown in the output, but I didn't want to complicate your life more for now by suggesting you use it :) |
I haven't been able to finish this (see TODOs at the end), but I figure that maybe someone else might be interested, or at some point in the future I'd get another bit of inspiration. In the meantime, I'd rather not have my effort so far go to a complete waste.
Note that the 3.12 details are often quite different and deserve a separate chapter, but as 3.12 is still very much in flux I'd rather wait with that.
Who else should I ask for a review? Maybe @brandtbucher ?