GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — [Doc] Remove unnecessary quotes from typing module by adorilson · Pull Request #137207 · python/cpython

Conversation

adorilson commented Jul 29, 2025 •

edited by github-actions Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

vstinner and others added 5 commits

July 29, 2025 14:46


          pythongh-106320: Remove private _PyInterpreterState functions (python…

db8893c

…#106335)

Remove private _PyThreadState and _PyInterpreterState C API
functions: move them to the internal C API (pycore_pystate.h and
pycore_interp.h). Don't export most of these functions anymore, but
still export functions used by tests.

Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C
API, but keep it in the stable API.


          Doc: minor change

ae4cf0d


          Revert "Doc: minor change"

3619b06

This reverts commit ebfa093.


          [Doc] Remove unnecessary quotes from typing (See Also section)

a8615f4


          [Doc] Remove unnecessary quotes from typing

899bd82

adorilson requested review from AlexWaygood and JelleZijlstra as code owners

July 29, 2025 15:00

bedevere-app Bot added awaiting review docs

Documentation in the Doc dir

skip news labels

Jul 29, 2025

github-project-automation Bot moved this to Todo in Docs PRs

Jul 29, 2025

github-project-automation Bot added this to Docs PRs

Jul 29, 2025

StanFromIreland added the skip issue label

Jul 29, 2025

StanFromIreland commented Jul 29, 2025

Copy link

Copy Markdown

Member

This is a purely cosmetic change IMO, I see little benefit in removing the quotes. Have they caused confusion?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

adorilson commented Jul 29, 2025

Copy link

Copy Markdown

Contributor Author

This is a purely cosmetic change IMO, I see little benefit in removing the quotes.

Beautiful is better than ugly. 🙂

In fact, this is purely cosmetic. But the more common form in docs is without these quotes (in a fast search).

Have they caused confusion?

It doesn´t cause confusion per si, in an absolute way or a concrete case for now. It can cause confusion, mainly because they are inside crases, both documentation maintainers and translators as well.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

JelleZijlstra commented Jul 30, 2025

Copy link

Copy Markdown

Member

Aren't the quotes correct here because we're quoting the title of the work being referred to?

StanFromIreland reacted with thumbs up emoji

All reactions

👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

adorilson commented Jul 30, 2025

Copy link

Copy Markdown

Contributor Author

Aren't the quotes correct here because we're quoting the title of the work being referred to?

It could be the author's intention, but it isn't the pattern. If it were true, we should put more quotes everywhere. I don't think it's a good idea.

At the same module, we have

When the link is all over the title, the docs style cares about the title being highlighted. I think it is enough and quotes are unnecessary (and ugly and more complicated to maintain).

However, in the case of

“Type System Reference” section of the mypy docs

the link isn't about the title. I guess that is because the section hasn't been anchored in mypy docs (it is only a menu separator), so it is not possible to link it directly. Here, the quotes make sense.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

orsenthil commented Aug 8, 2025

Copy link

Copy Markdown

Member

I agree with other reviewers on their comment. There are only two outcomes, we close this PR or accept it. I did a ag seealso -A 3 | less to see the inconsistency in docs, realized it is okay to merge this PR.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

orsenthil approved these changes

Aug 8, 2025

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting review labels

Aug 8, 2025

orsenthil merged commit f06fcb7 into python:main

Aug 8, 2025

github-project-automation Bot moved this from Todo to Done in Docs PRs

Aug 8, 2025

bedevere-app Bot removed the awaiting merge label

Aug 8, 2025

orsenthil added needs backport to 3.13

only security fixes

needs backport to 3.14 bugs and security fixes labels

Aug 8, 2025

miss-islington-app Bot commented Aug 8, 2025

Copy link

Copy Markdown

Thanks @adorilson for the PR, and @orsenthil for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington-app Bot commented Aug 8, 2025

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Aug 8, 2025


          [Doc] Remove unnecessary quotes from typing module (pythonGH-137207)

02de167

* pythongh-106320: Remove private _PyInterpreterState functions (pythonGH-106335)

Remove private _PyThreadState and _PyInterpreterState C API
functions: move them to the internal C API (pycore_pystate.h and
pycore_interp.h). Don't export most of these functions anymore, but
still export functions used by tests.

Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C
API, but keep it in the stable API.

* Doc: minor change

* Revert "Doc: minor change"

This reverts commit ebfa093.

* [Doc] Remove unnecessary quotes from typing (See Also section)

* [Doc] Remove unnecessary quotes from typing

---------
(cherry picked from commit f06fcb7)

Co-authored-by: Adorilson Bezerra <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Aug 8, 2025


          [Doc] Remove unnecessary quotes from typing module (pythonGH-137207)

86aee83

* pythongh-106320: Remove private _PyInterpreterState functions (pythonGH-106335)

Remove private _PyThreadState and _PyInterpreterState C API
functions: move them to the internal C API (pycore_pystate.h and
pycore_interp.h). Don't export most of these functions anymore, but
still export functions used by tests.

Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C
API, but keep it in the stable API.

* Doc: minor change

* Revert "Doc: minor change"

This reverts commit ebfa093.

* [Doc] Remove unnecessary quotes from typing (See Also section)

* [Doc] Remove unnecessary quotes from typing

---------
(cherry picked from commit f06fcb7)

Co-authored-by: Adorilson Bezerra <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>

bedevere-app Bot commented Aug 8, 2025

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label

Aug 8, 2025

bedevere-app Bot commented Aug 8, 2025

Copy link

Copy Markdown

GH-137541 is a backport of this pull request to the 3.14 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label

Aug 8, 2025

orsenthil pushed a commit that referenced this pull request

Aug 8, 2025


          [3.13] [Doc] Remove unnecessary quotes from typing module (GH-137207) (…

…#137540)

[Doc] Remove unnecessary quotes from typing module (GH-137207)

* gh-106320: Remove private _PyInterpreterState functions (GH-106335)

Remove private _PyThreadState and _PyInterpreterState C API
functions: move them to the internal C API (pycore_pystate.h and
pycore_interp.h). Don't export most of these functions anymore, but
still export functions used by tests.

Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C
API, but keep it in the stable API.

* Doc: minor change

* Revert "Doc: minor change"

This reverts commit ebfa093.

* [Doc] Remove unnecessary quotes from typing (See Also section)

* [Doc] Remove unnecessary quotes from typing

---------
(cherry picked from commit f06fcb7)

Co-authored-by: Adorilson Bezerra <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>

hugovk pushed a commit that referenced this pull request

Aug 8, 2025


          [3.14] [Doc] Remove unnecessary quotes from typing module (GH-137207) (…

3df0842

…#137541)

Co-authored-by: Adorilson Bezerra <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>

Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request

Aug 19, 2025


          [Doc] Remove unnecessary quotes from typing module (python#137207)

7e46457

* pythongh-106320: Remove private _PyInterpreterState functions (python#106335)

Remove private _PyThreadState and _PyInterpreterState C API
functions: move them to the internal C API (pycore_pystate.h and
pycore_interp.h). Don't export most of these functions anymore, but
still export functions used by tests.

Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C
API, but keep it in the stable API.

* Doc: minor change

* Revert "Doc: minor change"

This reverts commit ebfa093.

* [Doc] Remove unnecessary quotes from typing (See Also section)

* [Doc] Remove unnecessary quotes from typing

---------

Co-authored-by: Victor Stinner <[email protected]>

kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request

Sep 9, 2025


          [3.14] [Doc] Remove unnecessary quotes from typing module (pythonGH-1…

d22d68c

…37207) (python#137541)

Co-authored-by: Adorilson Bezerra <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>

Reviewers

orsenthil

orsenthil approved these changes

JelleZijlstra

Awaiting requested review from JelleZijlstra

JelleZijlstra is a code owner

AlexWaygood

Awaiting requested review from AlexWaygood

AlexWaygood is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs

Documentation in the Doc dir

skip issue skip news

Projects

Docs PRs

Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

Conversation

adorilson commented Jul 29, 2025 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

StanFromIreland commented Jul 29, 2025

Uh oh!

adorilson commented Jul 29, 2025

Uh oh!

JelleZijlstra commented Jul 30, 2025

Uh oh!

adorilson commented Jul 30, 2025

Uh oh!

orsenthil commented Aug 8, 2025

Uh oh!

miss-islington-app Bot commented Aug 8, 2025

Uh oh!

miss-islington-app Bot commented Aug 8, 2025

Uh oh!

bedevere-app Bot commented Aug 8, 2025

Uh oh!

bedevere-app Bot commented Aug 8, 2025

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

adorilson commented Jul 29, 2025 •

edited by github-actions Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.