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.

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

GH-96068: Document object layout #96069

Merged
merged 3 commits into from Aug 23, 2022

Conversation

markshannon
Copy link
Member

@markshannon markshannon commented Aug 18, 2022

@Fidget-Spinner
Copy link
Member

Fidget-Spinner commented Aug 18, 2022

Should we place this in the devguide instead?

@markshannon
Copy link
Member Author

markshannon commented Aug 18, 2022

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

Objects/object_layout.md Outdated Show resolved Hide resolved
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
@ericsnowcurrently
Copy link
Member

ericsnowcurrently commented Aug 19, 2022

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
Member Author

markshannon commented Aug 23, 2022

#96209

@markshannon markshannon merged commit 575f888 into python:main Aug 23, 2022
12 checks passed
mdboom pushed a commit to mdboom/cpython that referenced this pull request Aug 24, 2022
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.

None yet

5 participants