Skip to content

create an internals documentation folder in the cpython repo #119786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
iritkatriel opened this issue May 30, 2024 · 4 comments
Closed

create an internals documentation folder in the cpython repo #119786

iritkatriel opened this issue May 30, 2024 · 4 comments
Assignees
@iritkatriel
Labels
docs Documentation in the Doc dir

Comments

@iritkatriel
Copy link
Member

iritkatriel commented May 30, 2024 •
edited by bedevere-app bot
Loading

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

Cosmetic PRs
@iritkatriel iritkatriel added the docs Documentation in the Doc dir label May 30, 2024
@iritkatriel iritkatriel self-assigned this May 30, 2024
iritkatriel added a commit to iritkatriel/cpython that referenced this issue May 30, 2024
@iritkatriel
pythongh-119786: create folder in cpython repo for internals document…
d97f218 
…ation
@bedevere-app bedevere-app bot mentioned this issue May 30, 2024
Merged
iritkatriel added a commit to iritkatriel/cpython that referenced this issue May 30, 2024
@iritkatriel
pythongh-119786: create folder in cpython repo for internals document…
10ef7b6 
…ation
iritkatriel added a commit to iritkatriel/cpython that referenced this issue May 30, 2024
@iritkatriel
pythongh-119786: create folder in cpython repo for internals document…
f86a082 
…ation
iritkatriel added a commit that referenced this issue May 30, 2024
@iritkatriel
gh-119786: create folder in cpython repo for internals documentation (#…
e91fc11 
…119787)
@bedevere-app bedevere-app bot mentioned this issue May 30, 2024
Merged
iritkatriel added a commit that referenced this issue Jun 3, 2024
@iritkatriel
gh-119786: move exception handling doc to InternalDocs (#119815)
367adc9
mliezun pushed a commit to mliezun/cpython that referenced this issue Jun 3, 2024
@iritkatriel @mliezun
pythongh-119786: move exception handling doc to InternalDocs (python#…
f9871ff 
…119815)
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Jun 4, 2024
@iritkatriel
pythongh-119786: move interpreter doc from the devguide to InternalDocs
646632a
@bedevere-app bedevere-app bot mentioned this issue Jun 4, 2024
Closed
3 tasks
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Jun 4, 2024
@iritkatriel
pythongh-119786: add links to code
b40e822
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Jun 4, 2024
@iritkatriel
pythongh-119786: add links to code
0df6d67
@bedevere-app bedevere-app bot mentioned this issue Jun 4, 2024
Merged
iritkatriel added a commit that referenced this issue Jun 5, 2024
@iritkatriel
gh-119786: add links to code in exception handling doc (#120077)
10eac02
barneygale pushed a commit to barneygale/cpython that referenced this issue Jun 5, 2024
@iritkatriel @barneygale
pythongh-119786: move exception handling doc to InternalDocs (python#…
400bfbd 
…119815)
barneygale pushed a commit to barneygale/cpython that referenced this issue Jun 5, 2024
@iritkatriel @barneygale
pythongh-119786: add links to code in exception handling doc (python#…
37f92ed 
…120077)
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Jun 5, 2024
@iritkatriel
pythongh-119786: move adaptive interpreter doc from Python to Interna…
58fa42e 
…lsDoc
This was referenced Jun 5, 2024
Merged
Merged
iritkatriel added a commit that referenced this issue Jun 6, 2024
@iritkatriel
gh-119786: move adaptive interpreter doc from Python to InternalsDoc (#…
eeb8f67 
…120137)
iritkatriel added a commit that referenced this issue Jun 10, 2024
@iritkatriel @AA-Turner
@brettcannon @willingc @banool @sweeneyde @merwok @ezio-melotti @birkenfeld @gvanrossum @hugovk @jeff5 @DimitrisJim @Fidget-Spinner @Lincoln-developer @Mariatta @MahadMuhammad @ned-deily @pablogsal @serhiy-storchaka @matrixise @suriyaa @zware @psyker156 @slateny @soolabettu @zikcheng
gh-119786: copy compiler doc from devguide to InternalDocs and conver…
56c3815 
…t to markdown (#120134)

* gh-119876: move compiler doc from devguide to InternalDocs

Copy of python/devguide@78fc0d7

Co-Authored-By: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-Authored-By: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-Authored-By: Brett Cannon <brett@python.org>
Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
Co-Authored-By: Daniel Porteous <danielporteous1@gmail.com>
Co-Authored-By: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com>
Co-Authored-By: Éric Araujo <merwok@netwok.org>
Co-Authored-By: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Co-Authored-By: Ezio Melotti <ezio.melotti@gmail.com>
Co-Authored-By: Georg Brandl <georg@python.org>
Co-Authored-By: Guido van Rossum <guido@python.org>
Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-Authored-By: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Co-Authored-By: Jeff Allen <ja.py@farowl.co.uk>
Co-Authored-By: Jim Fasarakis-Hilliard <d.f.hilliard@gmail.com>
Co-Authored-By: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Co-Authored-By: Lincoln <71312724+Lincoln-developer@users.noreply.github.com>
Co-Authored-By: Mariatta <Mariatta@users.noreply.github.com>
Co-Authored-By: Muhammad Mahad <mahadpy@gmail.com>
Co-Authored-By: Ned Deily <nad@acm.org>
Co-Authored-By: Pablo Galindo Salgado <Pablogsal@gmail.com>
Co-Authored-By: Serhiy Storchaka <storchaka@gmail.com>
Co-Authored-By: Stéphane Wirtel <stephane@wirtel.be>
Co-Authored-By: Suriyaa ✌️️ <isc.suriyaa@gmail.com>
Co-Authored-By: Zachary Ware <zachary.ware@gmail.com>
Co-Authored-By: psyker156 <242220+psyker156@users.noreply.github.com>
Co-Authored-By: slateny <46876382+slateny@users.noreply.github.com>
Co-Authored-By: svelankar <17737361+svelankar@users.noreply.github.com>
Co-Authored-By: zikcheng <surfingbyte@gmail.com>

* convert to markdown

* add to index

* update more of the out of date stuff

---------

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Brett Cannon <brett@python.org>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Daniel Porteous <danielporteous1@gmail.com>
Co-authored-by: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com>
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Georg Brandl <georg@python.org>
Co-authored-by: Guido van Rossum <guido@python.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Jeff Allen <ja.py@farowl.co.uk>
Co-authored-by: Jim Fasarakis-Hilliard <d.f.hilliard@gmail.com>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Co-authored-by: Lincoln <71312724+Lincoln-developer@users.noreply.github.com>
Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Muhammad Mahad <mahadpy@gmail.com>
Co-authored-by: Ned Deily <nad@acm.org>
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
Co-authored-by: Suriyaa ✌️️ <isc.suriyaa@gmail.com>
Co-authored-by: Zachary Ware <zachary.ware@gmail.com>
Co-authored-by: psyker156 <242220+psyker156@users.noreply.github.com>
Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
Co-authored-by: svelankar <17737361+svelankar@users.noreply.github.com>
Co-authored-by: zikcheng <surfingbyte@gmail.com>
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Jun 13, 2024
@iritkatriel
pythongh-119786: move locations doc to InternalDocs. Delete lnotab_no…
83b9001 
…tes.txt as it is for older versions
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Jun 13, 2024
@iritkatriel
pythongh-119786: move locations doc to InternalDocs. Delete lnotab_no…
5c8f375 
…tes.txt as it is for older versions
@bedevere-app bedevere-app bot mentioned this issue Jun 13, 2024
Merged
iritkatriel added a commit that referenced this issue Jun 19, 2024
@iritkatriel
gh-119786: move locations doc to InternalDocs (#120445)
d484383
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Jun 25, 2024
@iritkatriel
pythongh-119786: move frames documentation to InternalDocs and add de…
ba933ea 
…tails
@bedevere-app bedevere-app bot mentioned this issue Jun 25, 2024
Merged
iritkatriel added a commit that referenced this issue Jun 26, 2024
@iritkatriel
gh-119786: move frames documentation to InternalDocs and add details (#…
c878767 
…121009)
@bedevere-app bedevere-app bot mentioned this issue Jan 5, 2025
Merged
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@picnixz @srinivasreddy
pythongh-119786: improve internal docs on co_linetable (python#123198)
eb3b040
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@picnixz @srinivasreddy
pythongh-119786: cleanup internal docs and fix internal links (python…
d9ee48c 
…#127485)
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@iritkatriel @srinivasreddy
pythongh-119786: Add jit.md. Move adaptive.md to a section of interpr…
f27b290 
…eter.md. (python#127175)
srinivasreddy added a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@srinivasreddy
pythongh-119786: fix typo in InternalDocs/garbage_collector.md (pyt…
14d9a07 
…hon#127687)
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@StanFromIreland @srinivasreddy
pythongh-119786: Fix miscellaneous typos in `InternalDocs/interpreter…
5e0bc40 
…_definition.md` (python#127957)
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@WolframAlph @srinivasreddy
pythongh-119786: Fix typos in InternalDocs/interpreter.md (python#1…
f42b555 
…28174)
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@WolframAlph @srinivasreddy
pythongh-119786: Fix typos in InternalDocs/frames.md (python#128275)
55a6102 
Fix typos in `InternalDocs/frames.md`
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@WolframAlph @srinivasreddy
pythongh-119786: Fix typos in InternalDocs/parser.md (python#128314)
fef2607
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this issue Jan 8, 2025
@WolframAlph @ZeroIntensity @srinivasreddy
pythongh-119786: Mention InternalDocs/interpreter.md instead of non…
378d062 
…-existing `adaptive.md` (python#128329)

`Python/specialize.c`: Mention `InternalDocs/interpreter.md` instead of non-existing `adaptive.md`


Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@iritkatriel @ebonnal
pythongh-119786: move interpreter doc from devguide to InternalDocs (p…
4c0c1f7 
…ython#125715)
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@iritkatriel @ebonnal
pythongh-119786: [doc] more consistent syntax in InternalDocs (python…
eab24b8 
…#125815)
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@iritkatriel @ebonnal
pythongh-119786: move 'changing grammar' checklist from devguide to I…
c2fd29f 
…nternalDocs (python#125874)
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@iritkatriel @ebonnal
pythongh-119786: add code object doc, inline locations.md into it (py…
4ff09eb 
…thon#126832)
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@picnixz @ebonnal
pythongh-119786: improve internal docs on co_linetable (python#123198)
f9e4710
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@picnixz @ebonnal
pythongh-119786: cleanup internal docs and fix internal links (python…
cf8394d 
…#127485)
iritkatriel added a commit that referenced this issue Jan 16, 2025
@iritkatriel
gh-119786: added InternalDocs/generators.md (#128524)
e81fe94
@sergey-miryanov sergey-miryanov mentioned this issue Jan 27, 2025
Merged
Eclips4 pushed a commit that referenced this issue Jan 27, 2025
@sergey-miryanov
gh-119786: Fix small typo in AST to CFG to bytecode section in compil…
a5075cd 
…er.md (#129322)
This was referenced Mar 13, 2025
Closed
Merged
iritkatriel pushed a commit that referenced this issue Mar 16, 2025
@nybblista
gh-119786: add JUMP_BACKWARD macro to the Jumps section (#131213)
23cda58 
add JUMP_BACKWARD opcode macro to the Jumps section

JUMP_BACKWARD opcode macro added to the Jumps section in
interpreter.md file at InternalDocs.
plashchynski pushed a commit to plashchynski/cpython that referenced this issue Mar 17, 2025
@nybblista @plashchynski
pythongh-119786: add JUMP_BACKWARD macro to the Jumps section (pyth…
1237ade 
…on#131213)

add JUMP_BACKWARD opcode macro to the Jumps section

JUMP_BACKWARD opcode macro added to the Jumps section in
interpreter.md file at InternalDocs.
@bedevere-app bedevere-app bot mentioned this issue Mar 17, 2025
Merged
iritkatriel pushed a commit that referenced this issue Mar 17, 2025
@nybblista
gh-119786: Fix _PyExecutorObject link at jit.md file (#131382)
149fbb0
colesbury pushed a commit to colesbury/cpython that referenced this issue Mar 20, 2025
@nybblista @colesbury
pythongh-119786: Fix _PyExecutorObject link at jit.md file (python#13…
c7fc49b 
…1382)
seehwan pushed a commit to seehwan/cpython that referenced this issue Apr 16, 2025
@nybblista @seehwan80
pythongh-119786: add JUMP_BACKWARD macro to the Jumps section (pyth…
1788ecd 
…on#131213)

add JUMP_BACKWARD opcode macro to the Jumps section

JUMP_BACKWARD opcode macro added to the Jumps section in
interpreter.md file at InternalDocs.
seehwan pushed a commit to seehwan/cpython that referenced this issue Apr 16, 2025
@nybblista @seehwan80
pythongh-119786: Fix _PyExecutorObject link at jit.md file (python#13…
e7b121b 
…1382)
@bedevere-app bedevere-app bot mentioned this issue Jun 14, 2025
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iritkatriel iritkatriel

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@colesbury @iritkatriel @Eclips4