Skip to content

GH-96068: Document object layout - #96069

Merged
markshannon merged 3 commits into
python:mainfrom
faster-cpython:document-object-layout
Aug 23, 2022
Merged

GH-96068: Document object layout#96069
markshannon merged 3 commits into
python:mainfrom
faster-cpython:document-object-layout

Conversation

@markshannon

@markshannon markshannon commented Aug 18, 2022

Copy link
Copy Markdown
Member

@markshannon markshannon added needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes labels Aug 18, 2022
@Fidget-Spinner

Copy link
Copy Markdown
Member

Should we place this in the devguide instead?

@markshannon

Copy link
Copy Markdown
Member Author

Maybe, but the further the docs are separated from the code, the more likely there are to get out of sync.

Ideally, they would be in the same file and automatically extracted. https://en.wikipedia.org/wiki/Literate_programming

Comment thread Objects/object_layout.md Outdated
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
@ericsnowcurrently

Copy link
Copy Markdown
Member

Maybe, but the further the docs are separated from the code, the more likely there are to get out of sync.

Agreed. I expect the object layout to be unstable enough that keeping it with the code will be important. Such implementation documentation in the devguide is more appropriate for designs that don't change much.

That said, it would be worth having a link in the devguide pointing to Objects/object_layout.md.

@markshannon

Copy link
Copy Markdown
Member Author

python/devguide#1159

@markshannon
markshannon merged commit 575f888 into python:main Aug 23, 2022
mdboom pushed a commit to mdboom/cpython that referenced this pull request Aug 24, 2022
@markshannon
markshannon deleted the document-object-layout branch September 26, 2023 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants