Skip to content

gh-130814: Enhance documentation for Python C API type objects#130817

Merged
picnixz merged 10 commits intopython:mainfrom
sharktide:patch-1
Mar 14, 2025
Merged

gh-130814: Enhance documentation for Python C API type objects#130817
picnixz merged 10 commits intopython:mainfrom
sharktide:patch-1

Conversation

@sharktide
Copy link
Copy Markdown
Contributor

@sharktide sharktide commented Mar 4, 2025 •
edited by bedevere-app bot
Loading

Update from

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

to

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

Based on issue #130814

@ghost
Copy link
Copy Markdown

ghost commented Mar 4, 2025 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app
Copy link
Copy Markdown

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
@bedevere-app bedevere-app bot mentioned this pull request Mar 4, 2025
Closed
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Mar 4, 2025
ZeroIntensity
ZeroIntensity reviewed Mar 4, 2025
View reviewed changes
Copy link
Copy Markdown
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?

@ZeroIntensity
Copy link
Copy Markdown
Member

ZeroIntensity commented Mar 4, 2025

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

@sharktide
Copy link
Copy Markdown
Contributor Author

sharktide commented Mar 4, 2025

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
Copy Markdown
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
Copy Markdown
Member

StanFromIreland commented Mar 4, 2025 •
edited
Loading

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

@StanFromIreland
Copy link
Copy Markdown
Member

StanFromIreland commented Mar 4, 2025 •
edited
Loading

@sharktide You do not need to update the branch

(This should be made more clear in the devguide)

@sharktide
Copy link
Copy Markdown
Contributor Author

sharktide commented Mar 4, 2025

ok

@picnixz picnixz self-assigned this Mar 13, 2025
@picnixz
Copy link
Copy Markdown
Member

picnixz commented Mar 14, 2025

do you think there's any added clarity here?

We don't necessarily need clarity, but it might be better for Sphinx indexing and search. (Otherwise you have two titles that are exactly the same). Also, the previous section is https://docs.python.org/3/c-api/structures.html so the notion of structure could already be in the mind of the reader.

@picnixz picnixz merged commit 6b932ed into python:main Mar 14, 2025
28 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Mar 14, 2025
@picnixz picnixz added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 14, 2025
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app bot commented Mar 14, 2025

Thanks @sharktide for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link
Copy Markdown

miss-islington-app bot commented Mar 14, 2025

Thanks @sharktide for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 14, 2025
@sharktide @miss-islington
pythongh-130814: Enhance documentation for Python C API type objects (p…
a80c3de 
…ythonGH-130817)

The "Type Objects" title in `c-api/typeobj.rst`, duplicating the title of `c-api/type.rst`,
has been changed to "Type Objects Structures", thereby slightly improving Sphinx
search.
(cherry picked from commit 6b932ed)

Co-authored-by: sharktide <meherrihaan@gmail.com>
@bedevere-app
Copy link
Copy Markdown

bedevere-app bot commented Mar 14, 2025

GH-131224 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 Mar 14, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 14, 2025
@sharktide @miss-islington
pythongh-130814: Enhance documentation for Python C API type objects (p…
d0c4c8f 
…ythonGH-130817)

The "Type Objects" title in `c-api/typeobj.rst`, duplicating the title of `c-api/type.rst`,
has been changed to "Type Objects Structures", thereby slightly improving Sphinx
search.
(cherry picked from commit 6b932ed)

Co-authored-by: sharktide <meherrihaan@gmail.com>
@bedevere-app
Copy link
Copy Markdown

bedevere-app bot commented Mar 14, 2025

GH-131225 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Mar 14, 2025
picnixz pushed a commit that referenced this pull request Mar 14, 2025
@miss-islington @sharktide
[3.13] gh-130814: Enhance documentation for Python C API type objects (…
6c10767 
…GH-130817) (#131225)

gh-130814: Enhance documentation for Python C API type objects (GH-130817)

The "Type Objects" title in `c-api/typeobj.rst`, duplicating the title of `c-api/type.rst`,
has been changed to "Type Objects Structures", thereby slightly improving Sphinx
search.
(cherry picked from commit 6b932ed)

Co-authored-by: sharktide <meherrihaan@gmail.com>
picnixz pushed a commit that referenced this pull request Mar 14, 2025
@miss-islington @sharktide
[3.12] gh-130814: Enhance documentation for Python C API type objects (…
77ece5a 
…GH-130817) (#131224)

gh-130814: Enhance documentation for Python C API type objects (GH-130817)

The "Type Objects" title in `c-api/typeobj.rst`, duplicating the title of `c-api/type.rst`,
has been changed to "Type Objects Structures", thereby slightly improving Sphinx
search.
(cherry picked from commit 6b932ed)

Co-authored-by: sharktide <meherrihaan@gmail.com>
mikec9 pushed a commit to mikec9/cpython that referenced this pull request Mar 14, 2025
@miss-islington @sharktide
[3.12] pythongh-130814: Enhance documentation for Python C API type o…
455638d 
…bjects (pythonGH-130817) (python#131224)

pythongh-130814: Enhance documentation for Python C API type objects (pythonGH-130817)

The "Type Objects" title in `c-api/typeobj.rst`, duplicating the title of `c-api/type.rst`,
has been changed to "Type Objects Structures", thereby slightly improving Sphinx
search.
(cherry picked from commit 6b932ed)

Co-authored-by: sharktide <meherrihaan@gmail.com>
plashchynski pushed a commit to plashchynski/cpython that referenced this pull request Mar 17, 2025
@sharktide @plashchynski
pythongh-130814: Enhance documentation for Python C API type objects (p…
a713278 
…ython#130817)

The "Type Objects" title in `c-api/typeobj.rst`, duplicating the title of `c-api/type.rst`,
has been changed to "Type Objects Structures", thereby slightly improving Sphinx
search.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ZeroIntensity ZeroIntensity ZeroIntensity left review comments

@picnixz picnixz picnixz approved these changes

Assignees

@picnixz picnixz

Labels

docs Documentation in the Doc dir skip news topic-C-API

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@sharktide @ZeroIntensity @picnixz @StanFromIreland