Skip to content

Apply 'mod' role to typing module #133201

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 30, 2025
Merged

Apply 'mod' role to typing module #133201

merged 2 commits into from
Apr 30, 2025
+5 −5

Conversation

rffontenelle
Copy link
Contributor

@rffontenelle rffontenelle commented Apr 30, 2025 •
edited by github-actions bot
Loading

To highlight the fact that "typing" is the module name, which e.g. would reduce the chance of an incorrect translation when translating Python docs.

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

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Apr 30, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Apr 30, 2025
@AlexWaygood
Copy link
Member

Could we use

:mod:`!typing`

rather than

:mod:`typing`

Otherwise Sphinx will add a link that just takes the reader to the page they're already on, which seems annoying/distracting

AA-Turner
AA-Turner reviewed Apr 30, 2025
View reviewed changes
@AA-Turner AA-Turner enabled auto-merge (squash) April 30, 2025 16:49
@AA-Turner AA-Turner merged commit 2b67db7 into python:main Apr 30, 2025
28 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Apr 30, 2025
@miss-islington-app
Copy link

Thanks @rffontenelle for the PR, and @AA-Turner 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 Apr 30, 2025
@rffontenelle @AA-Turner @miss-islington
Apply 'mod' role to typing module (pythonGH-133201)
fa0e763 
(cherry picked from commit 2b67db7)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Apr 30, 2025

GH-133217 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 Apr 30, 2025
@rffontenelle rffontenelle deleted the patch-8 branch April 30, 2025 16:53
AA-Turner added a commit that referenced this pull request Apr 30, 2025
@miss-islington @rffontenelle @AA-Turner
[3.13] Apply 'mod' role to typing module (GH-133201) (#133217)
4f006ff 
Apply 'mod' role to typing module (GH-133201)
(cherry picked from commit 2b67db7)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@Yzi-Li
Copy link
Contributor

Yzi-Li commented May 2, 2025 •
edited
Loading

I found the title of typing is

:mod:`typing`

Shoud we use

:mod:`!typing`

like other modules?

I did it in #133283.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AA-Turner AA-Turner AA-Turner left review comments

@AlexWaygood AlexWaygood AlexWaygood approved these changes

@JelleZijlstra JelleZijlstra Awaiting requested review from JelleZijlstra JelleZijlstra is a code owner

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news topic-typing
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rffontenelle @AlexWaygood @Yzi-Li @AA-Turner