gh-130814: Enhance documentation for Python C API type objects #130817
Conversation
|
All commit authors signed the Contributor License Agreement. |
|
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 |
sharktide
changed the title
sharktide
changed the title
ZeroIntensity
added
skip issue
skip news
docs
Misc/NEWS.d/next/Documentation/2025-03-04-01-23-42.gh-issue-130814.Tp3Ct1.rst
Outdated
Show resolved
Hide resolved
|
@picnixz (Sorry, I'm not sure why the tag didn't work the first time.) |
|
If It helps here is the documentation preview: The changed page is to add clarity since there are two pages with different content with the same title: The other page with the same title is this |
|
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 |
|
@ZeroIntensity You tagged @picnixz--do as it isn't smart enough to split it. (I've made this mistake before too :-) |
|
@sharktide You do not need to update the branch (This should be made more clear in the devguide) |
|
ok |
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
added
needs backport to 3.12
|
Thanks @sharktide for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
|
Thanks @sharktide for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
…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>
|
GH-131224 is a backport of this pull request to the 3.12 branch. |
…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>
|
GH-131225 is a backport of this pull request to the 3.13 branch. |
…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>
…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>
…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>
…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.
Update from
Type Objects ============to
Type Object Structures ======================Based on issue #130814