Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
AlexWaygood merged 1 commit intopython:mainfromAlexWaygood:code-obj-docs
Dec 6, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygoodAlexWaygood commentedDec 6, 2023•
edited by github-actionsbot
Loading

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

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

@AlexWaygood
Copy link
MemberAuthor

Copy link
Member

@hugovkhugovk 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 ismuch more readable than the dense paragraph.

BeforeAfter
imageimage

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

Thank you!

AlexWaygood reacted with heart emoji
@AlexWaygoodAlexWaygood merged commite9707d3 intopython:mainDec 6, 2023
@AlexWaygoodAlexWaygood deleted the code-obj-docs branchDecember 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 to3.12 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker e9707d3c3deb45a8352e85dbd5cf41afdb4a2a26 3.12
AlexWaygood reacted with thumbs down emoji

@miss-islington-app
Copy link

Sorry,@AlexWaygood, I could not cleanly backport this to3.11 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker e9707d3c3deb45a8352e85dbd5cf41afdb4a2a26 3.11

@bedevere-app
Copy link

GH-112816 is a backport of this pull request to the3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelDec 6, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull requestDec 6, 2023
AlexWaygood added a commit that referenced this pull requestDec 6, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull requestDec 6, 2023
@bedevere-app
Copy link

GH-112817 is a backport of this pull request to the3.11 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.11only security fixes labelDec 6, 2023
AlexWaygood added a commit that referenced this pull requestDec 6, 2023
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@hugovkhugovkhugovk approved these changes

@brettcannonbrettcannonAwaiting requested review from brettcannonbrettcannon is a code owner

@ericsnowcurrentlyericsnowcurrentlyAwaiting requested review from ericsnowcurrentlyericsnowcurrently is a code owner

@ncoghlanncoghlanAwaiting requested review from ncoghlanncoghlan is a code owner

@warsawwarsawAwaiting requested review from warsawwarsaw is a code owner

Assignees

@AlexWaygoodAlexWaygood

Labels
docsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@AlexWaygood@hugovk
[8]ページ先頭
©2009-2025 Movatter.jp