René's URL Explorer Experiment


Title: Introduce "type names" section to the style guide by sirosen · Pull Request #1828 · python/devguide · GitHub

Open Graph Title: Introduce "type names" section to the style guide by sirosen · Pull Request #1828 · python/devguide

X Title: Introduce "type names" section to the style guide by sirosen · Pull Request #1828 · python/devguide

Description: Resolves #1821 This enhancement to the style guide was motivated by a desire to resolve some inconsistent phrasing in the docs, which caused some disagreement in a CPython docs PR. The new section describes guidance for how type names should be documented. Class references or unlinked class styling are preferred, and other styles are described for use only when they are superior to the class name. The issue has no comments, but I introduced the idea in the docs community where it got some positive feedback. The discussion there helped to shape the issue, which has some basic 👍 s from a couple of core devs.

Open Graph Description: Resolves #1821 This enhancement to the style guide was motivated by a desire to resolve some inconsistent phrasing in the docs, which caused some disagreement in a CPython docs PR. The new section ...

X Description: Resolves #1821 This enhancement to the style guide was motivated by a desire to resolve some inconsistent phrasing in the docs, which caused some disagreement in a CPython docs PR. The new section ...

Opengraph URL: https://github.com/python/devguide/pull/1828

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:50f58a29-b75b-2f4a-2a9d-1ca45f7483a2
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idAE96:AE7DD:4817:65E5:6B005FC3
html-safe-nonceede867f9dc2e993cbda661637049d36d159b391ddb26ee39215e43d96267da36
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBRTk2OkFFN0REOjQ4MTc6NjVFNTo2QjAwNUZDMyIsInZpc2l0b3JfaWQiOiI0OTU4NDAwMjE0NDI0NjQxNDc1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac329efb8e61bfff384f21a596175bf9763cb2abe99e03eaa50d8440f4dc5b4953
hovercard-subject-tagpull_request:3817937595
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/python/devguide/pull/1828/files
twitter:imagehttps://avatars.githubusercontent.com/u/1300022?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/1300022?s=400&v=4
og:image:altResolves #1821 This enhancement to the style guide was motivated by a desire to resolve some inconsistent phrasing in the docs, which caused some disagreement in a CPython docs PR. The new section ...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None29be975efff6507a5d135de9c7d634cf7ff8f0c55222a64386ab3202209aaf73
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/python/devguide git https://github.com/python/devguide.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id63972479
octolytics-dimension-repository_nwopython/devguide
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id63972479
octolytics-dimension-repository_network_root_nwopython/devguide
turbo-body-classeslogged-out env-production page-responsive
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releaseeacd927ba6112e3b01ba99c762bd699a4a4f5df7
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python/devguide/pull/1828/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fdevguide%2Fpull%2F1828%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fdevguide%2Fpull%2F1828%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=python%2Fdevguide
Reloadhttps://github.com/python/devguide/pull/1828/files
Reloadhttps://github.com/python/devguide/pull/1828/files
Reloadhttps://github.com/python/devguide/pull/1828/files
pythonhttps://github.com/python
devguidehttps://github.com/python/devguide
Codehttps://github.com/python/devguide
Issues83 (83)https://github.com/python/devguide/issues
Pull requests41 (41)https://github.com/python/devguide/pulls
Actionshttps://github.com/python/devguide/actions
Projectshttps://github.com/python/devguide/projects
Security and qualityhttps://github.com/python/devguide/security
Insightshttps://github.com/python/devguide/insights
Sign up for GitHub https://github.com/signup?return_to=%2Fpython%2Fdevguide%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fpython%2Fdevguide%2Fissues%2Fnew%2Fchoose
hugovkhttps://github.com/hugovk
python:mainhttps://github.com/python/devguide/tree/main
sirosen:add-type-names-style-guidehttps://github.com/sirosen/devguide/tree/add-type-names-style-guide
Conversation 17 https://github.com/python/devguide/pull/1828
Commits 6 https://github.com/python/devguide/pull/1828/commits
Checks 2 https://github.com/python/devguide/pull/1828/checks
Files changed https://github.com/python/devguide/pull/1828/files
Please reload this pagehttps://github.com/python/devguide/pull/1828/files
Introduce "type names" section to the style guide https://github.com/python/devguide/pull/1828/files#top
Show all changes 6 commits https://github.com/python/devguide/pull/1828/files
8935bce Introduce "type names" section to the style guide sirosen Jun 7, 2026 https://github.com/python/devguide/pull/1828/commits/8935bce29ecf46124f09a3c4c3cdd357b07e8b18
1328257 Apply suggestion from @StanFromIreland sirosen Jun 7, 2026 https://github.com/python/devguide/pull/1828/commits/1328257625d1bd968e28be93aebbb7c19e72e88b
3c5e2c7 Move "specific words" and "type names" down in page sirosen Jun 11, 2026 https://github.com/python/devguide/pull/1828/commits/3c5e2c7fea8809a89a5470c9fa6b0eefb9a24a5e
e0faa0c Add explicit anchor for style-guide links section sirosen Jun 12, 2026 https://github.com/python/devguide/pull/1828/commits/e0faa0c1b4e4693932d0095e3a5899114a8d30ab
81deaa3 Make the style-guide 'links' ref more usable sirosen Jun 12, 2026 https://github.com/python/devguide/pull/1828/commits/81deaa3e1e35d3da418e9c0df96ae0a08d96f18f
86a969f Reframe type names guide to allow more judgement sirosen Jun 30, 2026 https://github.com/python/devguide/pull/1828/commits/86a969fab93b49c6bbf5e8a28a2d07a84f2095ab
Clear filters https://github.com/python/devguide/pull/1828/files
Please reload this pagehttps://github.com/python/devguide/pull/1828/files
Please reload this pagehttps://github.com/python/devguide/pull/1828/files
documentation/style-guide.rsthttps://github.com/python/devguide/pull/1828/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
View file https://github.com/sirosen/devguide/blob/86a969fab93b49c6bbf5e8a28a2d07a84f2095ab/documentation/style-guide.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1828/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1828/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
https://github.com/python/devguide/pull/1828/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
https://github.com/python/devguide/pull/1828/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
https://github.com/python/devguide/pull/1828/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
https://github.com/python/devguide/pull/1828/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
https://github.com/python/devguide/pull/1828/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
Please reload this pagehttps://github.com/python/devguide/pull/1828/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.