GH-96068: Document object layout - #96069
Merged
Merged
Conversation
Member
|
Should we place this in the devguide instead? |
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 |
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Member
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. |
Member
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.