Skip to content
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

create an internals documentation folder in the cpython repo #119786

Open
iritkatriel opened this issue May 30, 2024 · 4 comments
Open

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
@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 <[email protected]>
Co-Authored-By: Adam Turner <[email protected]>
Co-Authored-By: Brett Cannon <[email protected]>
Co-Authored-By: Carol Willing <[email protected]>
Co-Authored-By: Daniel Porteous <[email protected]>
Co-Authored-By: Dennis Sweeney <[email protected]>
Co-Authored-By: Éric Araujo <[email protected]>
Co-Authored-By: Erlend Egeberg Aasland <[email protected]>
Co-Authored-By: Ezio Melotti <[email protected]>
Co-Authored-By: Georg Brandl <[email protected]>
Co-Authored-By: Guido van Rossum <[email protected]>
Co-Authored-By: Hugo van Kemenade <[email protected]>
Co-Authored-By: Irit Katriel <[email protected]>
Co-Authored-By: Jeff Allen <[email protected]>
Co-Authored-By: Jim Fasarakis-Hilliard <[email protected]>
Co-Authored-By: Ken Jin <[email protected]>
Co-Authored-By: Lincoln <[email protected]>
Co-Authored-By: Mariatta <[email protected]>
Co-Authored-By: Muhammad Mahad <[email protected]>
Co-Authored-By: Ned Deily <[email protected]>
Co-Authored-By: Pablo Galindo Salgado <[email protected]>
Co-Authored-By: Serhiy Storchaka <[email protected]>
Co-Authored-By: Stéphane Wirtel <[email protected]>
Co-Authored-By: Suriyaa ✌️️ <[email protected]>
Co-Authored-By: Zachary Ware <[email protected]>
Co-Authored-By: psyker156 <[email protected]>
Co-Authored-By: slateny <[email protected]>
Co-Authored-By: svelankar <[email protected]>
Co-Authored-By: zikcheng <[email protected]>

* convert to markdown

* add to index

* update more of the out of date stuff

---------

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Brett Cannon <[email protected]>
Co-authored-by: Carol Willing <[email protected]>
Co-authored-by: Daniel Porteous <[email protected]>
Co-authored-by: Dennis Sweeney <[email protected]>
Co-authored-by: Éric Araujo <[email protected]>
Co-authored-by: Erlend Egeberg Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Georg Brandl <[email protected]>
Co-authored-by: Guido van Rossum <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Jeff Allen <[email protected]>
Co-authored-by: Jim Fasarakis-Hilliard <[email protected]>
Co-authored-by: Ken Jin <[email protected]>
Co-authored-by: Lincoln <[email protected]>
Co-authored-by: Mariatta <[email protected]>
Co-authored-by: Muhammad Mahad <[email protected]>
Co-authored-by: Ned Deily <[email protected]>
Co-authored-by: Pablo Galindo Salgado <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>
Co-authored-by: Stéphane Wirtel <[email protected]>
Co-authored-by: Suriyaa ✌️️ <[email protected]>
Co-authored-by: Zachary Ware <[email protected]>
Co-authored-by: psyker156 <[email protected]>
Co-authored-by: slateny <[email protected]>
Co-authored-by: svelankar <[email protected]>
Co-authored-by: zikcheng <[email protected]>
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)
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 8, 2024
@iritkatriel
pythongh-119786: Move parser doc from devguide to InternalDocs
3d83120
@bedevere-app bedevere-app bot mentioned this issue Oct 8, 2024
Merged
iritkatriel added a commit that referenced this issue Oct 9, 2024
@iritkatriel @JacobCoffee
@willingc @AA-Turner @cfbolz @erlend-aasland @ezio-melotti @hugovk @itamaro @JulienPalard @potpath @MahadMuhammad @nedbat @pablogsal @slateny @wookie184
gh-119786: Move parser doc from devguide to InternalDocs (#125119)
d501153 
Co-authored-by: Jacob Coffee <[email protected]>
Co-authored-by: Carol Willing <[email protected]>
Co-Authored-By: Adam Turner <[email protected]>
Co-Authored-By: Carl Friedrich Bolz-Tereick <[email protected]>
Co-Authored-By: Carol Willing <[email protected]>
Co-Authored-By: Erlend E. Aasland <[email protected]>
Co-Authored-By: Ezio Melotti <[email protected]>
Co-Authored-By: Hugo van Kemenade <[email protected]>
Co-Authored-By: Irit Katriel <[email protected]>
Co-Authored-By: Itamar Ostricher <[email protected]>
Co-Authored-By: Julien Palard <[email protected]>
Co-Authored-By: Mana <[email protected]>
Co-Authored-By: Muhammad Mahad <[email protected]>
Co-Authored-By: Ned Batchelder <[email protected]>
Co-Authored-By: Pablo Galindo Salgado <[email protected]>
Co-Authored-By: slateny <[email protected]>
Co-Authored-By: wookie184 <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Oct 10, 2024
Merged
iritkatriel added a commit that referenced this issue Oct 11, 2024
@iritkatriel @AA-Turner @JacobCoffee
gh-119786: Move garbage collection doc from devguide to InternalDocs (#…
89515be 
…125282)

Co-Authored-By: Carol Willing [email protected]
Co-Authored-By: Ezio Melotti [email protected]
Co-Authored-By: Hugo van Kemenade [email protected]
Co-Authored-By: Itamar Ostricher [email protected]
Co-Authored-By: Jesús Cea [email protected]
Co-Authored-By: Joannah Nanjekye [email protected]
Co-Authored-By: Ned Batchelder [email protected]
Co-Authored-By: Pablo Galindo Salgado [email protected]
Co-Authored-By: Pamela Fox [email protected]
Co-Authored-By: Sam Gross [email protected]
Co-Authored-By: Stefan Pochmann [email protected]
Co-Authored-By: T. Wouters [email protected]
Co-Authored-By: q-ata [email protected]
Co-Authored-By: slateny [email protected]
Co-Authored-By: Борис Верховский [email protected]
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Jacob Coffee <[email protected]>
efimov-mikhail added a commit to efimov-mikhail/cpython that referenced this issue Oct 14, 2024
@efimov-mikhail
pythongh-119786: move bytecode interpreter doc to InternalDocs
0bfc54d
@bedevere-app bedevere-app bot mentioned this issue Oct 14, 2024
Merged
efimov-mikhail added a commit to efimov-mikhail/cpython that referenced this issue Oct 14, 2024
@efimov-mikhail
pythongh-119786: fix typo in compiler.md
3882686
@bedevere-app bedevere-app bot mentioned this issue Oct 14, 2024
Merged
iritkatriel pushed a commit that referenced this issue Oct 14, 2024
@efimov-mikhail
gh-119786: [doc] broken link and typo fix in interpreter_definition.md (
187580d 
#125455)
iritkatriel pushed a commit that referenced this issue Oct 15, 2024
@efimov-mikhail
gh-119786: fix typo in compiler.md (#125456)
b903fc3
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 18, 2024
@iritkatriel
pythongh-119786: move interpreter doc from devguide to InternalDocs
f59037b
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 18, 2024
@iritkatriel
pythongh-119786: move interpreter doc from devguide to InternalDocs
7148b3c
@bedevere-app bedevere-app bot mentioned this issue Oct 18, 2024
Merged
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 18, 2024
@iritkatriel
pythongh-119786: move interpreter doc from devguide to InternalDocs
d65ee0f
iritkatriel added a commit that referenced this issue Oct 21, 2024
@iritkatriel
gh-119786: move interpreter doc from devguide to InternalDocs (#125715)
695814c
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 21, 2024
@iritkatriel
pythongh-119786: [doc] more consistent formatting in InternalDocs
1149465
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 21, 2024
@iritkatriel
pythongh-119786: [doc] more consistent formatting in InternalDocs
5c0b932
@bedevere-app bedevere-app bot mentioned this issue Oct 21, 2024
Merged
iritkatriel added a commit that referenced this issue Oct 21, 2024
@iritkatriel
gh-119786: [doc] more consistent syntax in InternalDocs (#125815)
d0bfff4
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 23, 2024
@iritkatriel
pythongh-119786: move 'changing grammar' checklist from devguide to I…
8ff1292 
…nternalDocs
@bedevere-app bedevere-app bot mentioned this issue Oct 23, 2024
Merged
iritkatriel added a commit that referenced this issue Oct 23, 2024
@iritkatriel
gh-119786: move 'changing grammar' checklist from devguide to Interna…
de0d5c6 
…lDocs (#125874)
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 23, 2024
@iritkatriel
pythongh-119786:: move 'repo structure' and 'additional resources' fr…
ff1a110 
…om devguide to InternalDocs
@bedevere-app bedevere-app bot mentioned this issue Oct 23, 2024
Closed
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Nov 14, 2024
@iritkatriel
pythongh-119786: add code object doc, inline locations.md into it
9817511
@bedevere-app bedevere-app bot mentioned this issue Nov 14, 2024
Merged
iritkatriel added a commit that referenced this issue Nov 22, 2024
@iritkatriel
gh-119786: add code object doc, inline locations.md into it (#126832)
4b12a6f
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Nov 22, 2024
@iritkatriel
pythongh-119786: add intro to adaptive.md. Update index headings
2a4bc06
@bedevere-app bedevere-app bot mentioned this issue Nov 22, 2024
Open
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