You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I notice that the CPython repository now contains information on the implementation, migrated from the Dev Guide. Let's migrate ours to here. I think it is more likely to be kept up to date if it is in close proximity to the code.
I find this kind of information about CPython helpful. I find it helpful to write similar things about Jython too, and believe it helps others to read them.
Java affords us better ways than C to document implementation in the source itself. However, there is logic that spans classes and packages, for which some sort of definitive guide would have been helpful to me as a beginner ... more honestly, I could do with it now.
We have bits of that kind of information in the old wiki, where it feels constantly at risk, and material in a few other scattered locations.
The CPython Dev Guide seems likely to retain its sections on contribution and release process. This makes sense because it applies to more than one repository (including ours). Our Dev Guide tries to piggy-back off the CPython one, but it's too complicated to maintain. It could be more manageable if it didn't pretend to be the architecture guide too.
Inspired partly by the tail end of #338 (comment) and partly by other conversations, a good first target is to document the release process. We have good account of that in reStructuredText but it is surrounded by misleading legacy text (a failed attempt at re-using the CPython devguide).
CPython has moved a lot of description of CPython internals from their dev guide to ~/InternalDocs but seems to want to keep a distinct dev guide. https://devguide.python.org/ for ground rules and workflow. (See also their PR 142237.) A lot of that is really useful but we need our own replacement for the workflow aspect. I propose a ~/DevGuide in the repo, covering just the differences. (Also a ~/InternalDocs, but that's another issue.)
Activity
jeff5 commentedon Apr 7, 2026
Inspired partly by the tail end of #338 (comment) and partly by other conversations, a good first target is to document the release process. We have good account of that in reStructuredText but it is surrounded by misleading legacy text (a failed attempt at re-using the CPython devguide).
CPython has moved a lot of description of CPython internals from their dev guide to
~/InternalDocsbut seems to want to keep a distinct dev guide. https://devguide.python.org/ for ground rules and workflow. (See also their PR 142237.) A lot of that is really useful but we need our own replacement for the workflow aspect. I propose a~/DevGuidein the repo, covering just the differences. (Also a~/InternalDocs, but that's another issue.)