From f86a0827dfb75b6c6fe75719308f7aff8d59ad98 Mon Sep 17 00:00:00 2001 From: Irit Katriel Date: Thu, 30 May 2024 16:35:36 +0100 Subject: [PATCH 1/3] gh-119786: create folder in cpython repo for internals documentation --- InternalsDoc/index.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 InternalsDoc/index.md diff --git a/InternalsDoc/index.md b/InternalsDoc/index.md new file mode 100644 index 00000000000000..b2a5f97fc9d7df --- /dev/null +++ b/InternalsDoc/index.md @@ -0,0 +1,16 @@ + +# CPython Internals Documentation + +The documentation in this fodler is intended for CPython maintainers. +It described 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). + + + + From 37b2714ebbbbfbfda7670be704997082a287c69a Mon Sep 17 00:00:00 2001 From: Irit Katriel <1055913+iritkatriel@users.noreply.github.com> Date: Thu, 30 May 2024 16:51:38 +0100 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Brandt Bucher --- InternalsDoc/index.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/InternalsDoc/index.md b/InternalsDoc/index.md index b2a5f97fc9d7df..32b66a254bcf2c 100644 --- a/InternalsDoc/index.md +++ b/InternalsDoc/index.md @@ -1,8 +1,8 @@ # CPython Internals Documentation -The documentation in this fodler is intended for CPython maintainers. -It described implementation details of CPython, which should not be +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. @@ -10,7 +10,3 @@ 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). - - - - From 9be8f342733ec73f1c4206cc0ff9243577b7ab1e Mon Sep 17 00:00:00 2001 From: Irit Katriel Date: Thu, 30 May 2024 17:16:49 +0100 Subject: [PATCH 3/3] rename folder --- {InternalsDoc => InternalDocs}/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {InternalsDoc => InternalDocs}/index.md (100%) diff --git a/InternalsDoc/index.md b/InternalDocs/index.md similarity index 100% rename from InternalsDoc/index.md rename to InternalDocs/index.md