Skip to content

gh-119786: create folder in cpython repo for internals documentation #119787

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

Merged
merged 3 commits into from
May 30, 2024
Merged

gh-119786: create folder in cpython repo for internals documentation #119787

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f86a082
gh-119786: create folder in cpython repo for internals documentation
iritkatriel May 30, 2024
37b2714
Apply suggestions from code review
iritkatriel May 30, 2024
9be8f34
rename folder
iritkatriel May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions InternalDocs/index.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you name this README.md it'll be rendered at https://github.com/python/cpython/tree/main/InternalDocs

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

# CPython Internals Documentation

The documentation in this folder is intended for CPython maintainers.
It describes implementation details of CPython, which should not be
assumed to be part of the Python language specification. These details
can change between any two CPython versions and should not be assumed
to hold for other implementations of the Python language.

The core dev team attempts to keep this documentation up to date. If
it is not, please report that through the
[issue tracker](https://github.com/python/cpython/issues).