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-130814: Enhance documentation for Python C API type objects #130817

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

sharktide
Copy link

@sharktide sharktide commented Mar 4, 2025

Update from

Type Objects
============

to

Type Object Structures
======================

Based on issue #130814

Copy link

cpython-cla-bot bot commented Mar 4, 2025

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app
Copy link

bedevere-app bot commented Mar 4, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@sharktide sharktide changed the title Rename typeobj.rst title for issue #130814 Fix issue #130814: Improve documentation for type objects Mar 4, 2025
@sharktide sharktide changed the title Fix issue #130814: Improve documentation for type objects gh-130814: Enhance documentation for Python C API type objects Mar 4, 2025
Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

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

I'm not particularly convinced we need this, but perhaps it's worth considering. cc @picnixz--do you think there's any added clarity here?

Copy link
Member

Choose a reason for hiding this comment

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

No need for this, we skip blurb entries for documentation changes--the "Documentation" section is for changes to the docs build.

Copy link
Author

Choose a reason for hiding this comment

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

Should I get rid of it

Copy link
Member

Choose a reason for hiding this comment

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

Yup!

Copy link
Author

Choose a reason for hiding this comment

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

ok

Copy link
Author

Choose a reason for hiding this comment

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

done

@ZeroIntensity
Copy link
Member

@picnixz (Sorry, I'm not sure why the tag didn't work the first time.)

@sharktide
Copy link
Author

If It helps here is the documentation preview:
📚 Documentation preview 📚: https://cpython-previews--130817.org.readthedocs.build/

The changed page is to add clarity since there are two pages with different content with the same title:

preview new page

original page

The other page with the same title is this

@picnixz picnixz self-requested a review March 4, 2025 13:15
@picnixz
Copy link
Member

picnixz commented Mar 4, 2025

I'm not sure I'll have time for review today. And I'm leaving for 10 days so I won't be back until the mid/end of next week

@StanFromIreland
Copy link
Contributor

StanFromIreland commented Mar 4, 2025

@ZeroIntensity You tagged @picnixz--do as it isn't smart enough to split it. (I've made this mistake before too :-)

@StanFromIreland
Copy link
Contributor

StanFromIreland commented Mar 4, 2025

@sharktide You do not need to update the branch

(This should be made more clear in the devguide)

@sharktide
Copy link
Author

ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

4 participants