FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-130814: Enhance documentation for Python C API type objects by sharktide · Pull Request #130817 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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

Merged
picnixz merged 10 commits into
python:mainfrom
sharktide:patch-1
Mar 14, 2025
ConversationCommits (10)ChecksFiles changed
Merged

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

Conversation

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

Copy link
Copy Markdown
Contributor

Update from

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

to

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

Based on issue #130814

ghost commented Mar 4, 2025 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

bedevere-app Bot commented Mar 4, 2025

Copy link
Copy Markdown

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 changed the title Rename typeobj.rst title for issue #130814 Fix issue #130814: Improve documentation for type objects Mar 4, 2025
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 Bot mentioned this pull request Mar 4, 2025
Closed
github-project-automation Bot moved this to Todo in Docs PRs Mar 4, 2025
ZeroIntensity reviewed Mar 4, 2025
View reviewed changes

ZeroIntensity left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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?

Comment thread Misc/NEWS.d/next/Documentation/2025-03-04-01-23-42.gh-issue-130814.Tp3Ct1.rst Outdated

ZeroIntensity commented Mar 4, 2025

Copy link
Copy Markdown
Member

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

sharktide commented Mar 4, 2025

Copy link
Copy Markdown
Contributor 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 self-requested a review March 4, 2025 13:15

picnixz commented Mar 4, 2025

Copy link
Copy Markdown
Member

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 commented Mar 4, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

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

StanFromIreland commented Mar 4, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

@sharktide You do not need to update the branch

(This should be made more clear in the devguide)

sharktide commented Mar 4, 2025

Copy link
Copy Markdown
Contributor Author

ok

picnixz self-assigned this Mar 13, 2025

picnixz commented Mar 14, 2025

Copy link
Copy Markdown
Member

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 merged commit 6b932ed into python:main Mar 14, 2025
github-project-automation Bot moved this from Todo to Done in Docs PRs Mar 14, 2025
picnixz added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels Mar 14, 2025

miss-islington-app Bot commented Mar 14, 2025

Copy link
Copy Markdown

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

miss-islington-app Bot commented Mar 14, 2025

Copy link
Copy Markdown

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
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 Bot commented Mar 14, 2025

Copy link
Copy Markdown

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

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
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 Bot commented Mar 14, 2025

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Mar 14, 2025
picnixz pushed a commit that referenced this pull request Mar 14, 2025
[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
[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
[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
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ZeroIntensity ZeroIntensity left review comments
picnixz picnixz approved these changes

Assignees

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

Back | FazBrowse Home | New Git URL