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-101100: Improve documentation of code object attributes #112781

Merged
merged 1 commit into from
Dec 6, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Dec 6, 2023

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


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

@AlexWaygood
Copy link
Member Author

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
31 checks passed
@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 bug and security fixes label Dec 6, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 6, 2023
AlexWaygood added a commit that referenced this pull request Dec 6, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 6, 2023
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants