create an internals documentation folder in the cpython repo

python / cpython

The Python programming language

https://www.python.org

Other

62.84k stars 30.1k forks source link

create an internals documentation folder in the cpython repo #119786

Open iritkatriel opened 4 months ago

iritkatriel commented 4 months ago

The internals documentation is scattered in markdown files in the codebase, as well as parts which are in the dev guide. We would like to have it in one place, versioned along with the code (unlike the dev guide).

Linked PRs

gh-119787
gh-119815
gh-120077
gh-120137
gh-120134
gh-120445
gh-121009
gh-121601
gh-123198
gh-124450
gh-124989
gh-124990
gh-125119

colesbury commented 3 months ago

FYI, there are a few broken links:

frame_layout.md: https://github.com/search?q=repo%3Apython%2Fcpython%20frame_layout.md&type=code
The first few links in this section: https://github.com/python/cpython/blob/main/InternalDocs/compiler.md#objects

Eclips4 commented 2 weeks ago

I think it's worth moving Python/tier2_engine.md and Python/vm_state.md to the InternalDocs directory. What do you think, Irit?

iritkatriel commented 2 weeks ago

Yes, but it needs to be reviewed to make sure verrything is up to date while we do that. Would you like to make a PR? I'm happy to help review.

Eclips4 commented 2 weeks ago

Yes, but it needs to be reviewed to make sure verrything is up to date while we do that. Would you like to make a PR? I'm happy to help review.

Yes, I'd be happy to send a PR.