Skip to content

gh-101100: Improve documentation of code object attributes #112781

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

Jump to bottom
Merged
merged 1 commit into from
Dec 6, 2023
Merged

gh-101100: Improve documentation of code object attributes #112781

merged 1 commit into from
Dec 6, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Dec 6, 2023 •
edited by github-actions bot
Loading

This gets us down to 41 Sphinx warnings in the datamodel docs.

📚 Documentation preview 📚: https://cpython-previews--112781.org.readthedocs.build/

@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 6, 2023
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting core review labels Dec 6, 2023
@bedevere-app bedevere-app bot mentioned this pull request Dec 6, 2023
Open
@AlexWaygood
Copy link
Member Author

Docs preview for the table in the datamodel docs: https://cpython-previews--112781.org.readthedocs.build/en/112781/reference/datamodel.html#special-read-only-attributes

hugovk
hugovk approved these changes Dec 6, 2023
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

The table is much more readable than the dense paragraph.

Before After
image image

Bonus points for using the Sphinx list-table structure, makes it much easier to maintain in the future than padding lots of whitespace with the ASCII layout one.

Thank you!

@AlexWaygood AlexWaygood merged commit e9707d3 into python:main Dec 6, 2023
@AlexWaygood AlexWaygood deleted the code-obj-docs branch December 6, 2023 20:15
@miss-islington-app
Copy link

Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @AlexWaygood, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker e9707d3c3deb45a8352e85dbd5cf41afdb4a2a26 3.12

@miss-islington-app
Copy link

Sorry, @AlexWaygood, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker e9707d3c3deb45a8352e85dbd5cf41afdb4a2a26 3.11

@bedevere-app
Copy link

bedevere-app bot commented Dec 6, 2023

GH-112816 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Dec 6, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 6, 2023
@AlexWaygood
[3.12] pythongh-101100: Improve documentation of code object attribut…
f5e976d 
…es (python#112781)

(cherry-picked from commit e9707d3)
AlexWaygood added a commit that referenced this pull request Dec 6, 2023
@AlexWaygood
[3.12] gh-101100: Improve documentation of code object attributes (#1…
ca11aec 
…12781) (#112816)

(cherry-picked from commit e9707d3)
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 6, 2023
@AlexWaygood
[3.11] pythongh-101100: Improve documentation of code object attribut…
648d1e0 
…es (python#112781)

(cherry-picked from commit e9707d3)
@bedevere-app
Copy link

bedevere-app bot commented Dec 6, 2023

GH-112817 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Dec 6, 2023
AlexWaygood added a commit that referenced this pull request Dec 6, 2023
@AlexWaygood
[3.11] gh-101100: Improve documentation of code object attributes (#1…
5fa2d24 
…12781) (#112817)

(cherry-picked from commit e9707d3)
This was referenced Dec 31, 2023
Open
Merged
@AlexWaygood AlexWaygood mentioned this pull request Jan 19, 2024
Closed
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AlexWaygood @aisk
pythongh-101100: Improve documentation of code object attributes (pyt…
a774d2b 
…hon#112781)
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@AlexWaygood @Glyphack
pythongh-101100: Improve documentation of code object attributes (pyt…
16fcef8 
…hon#112781)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk approved these changes

@brettcannon brettcannon Awaiting requested review from brettcannon brettcannon is a code owner

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

@ncoghlan ncoghlan Awaiting requested review from ncoghlan ncoghlan is a code owner

@warsaw warsaw Awaiting requested review from warsaw warsaw is a code owner

Assignees

@AlexWaygood AlexWaygood

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlexWaygood @hugovk