René's URL Explorer Experiment


Title: Add a note to the style guide about abbreviations by sirosen · Pull Request #1844 · python/devguide · GitHub

Open Graph Title: Add a note to the style guide about abbreviations by sirosen · Pull Request #1844 · python/devguide

X Title: Add a note to the style guide about abbreviations by sirosen · Pull Request #1844 · python/devguide

Description: Hat tip to @hugovk for this! Not only the issue (#1824), but also his comments preceding it made this easy to write. This as a draft because it conflicts with #1828, which is already approved and should ideally merge first. Once that's done, the exact positioning of this content in the page may change. Open question: should this be converted to be a subsection of "Use simple language" or "Specific words"? resolves #1824 After the section on specific terms, but before "simple language", add a section that explains that documentation should spell out acronyms, preferring the " ()" format.

Open Graph Description: Hat tip to @hugovk for this! Not only the issue (#1824), but also his comments preceding it made this easy to write. This as a draft because it conflicts with #1828, which is already approved and s...

X Description: Hat tip to @hugovk for this! Not only the issue (#1824), but also his comments preceding it made this easy to write. This as a draft because it conflicts with #1828, which is already approved and s...

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

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:9341381f-de43-adfe-be47-332e01bcea83
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id8BB4:9EA06:406E:5CCD:6B005FBB
html-safe-nonce782c28762ea2d23c21a7d5926c1521121b13f53dc16e9b49565937489d1c544e
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QkI0OjlFQTA2OjQwNkU6NUNDRDo2QjAwNUZCQiIsInZpc2l0b3JfaWQiOiI4NzE4OTcxNzI3OTQ3Nzg0MTIzIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac5b46957c712c8f0186fd468f6d73dcf4b92f859da789e71aa769f88a4b385b28
hovercard-subject-tagpull_request:3939439765
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/1844/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:altHat tip to @hugovk for this! Not only the issue (#1824), but also his comments preceding it made this easy to write. This as a draft because it conflicts with #1828, which is already approved and s...
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 full-width
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/1844/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fdevguide%2Fpull%2F1844%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%2F1844%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/1844/files
Reloadhttps://github.com/python/devguide/pull/1844/files
Reloadhttps://github.com/python/devguide/pull/1844/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
StanFromIrelandhttps://github.com/StanFromIreland
python:mainhttps://github.com/python/devguide/tree/main
sirosen:add-abbreviations-to-style-guidehttps://github.com/sirosen/devguide/tree/add-abbreviations-to-style-guide
Conversation 25 https://github.com/python/devguide/pull/1844
Commits 7 https://github.com/python/devguide/pull/1844/commits
Checks 2 https://github.com/python/devguide/pull/1844/checks
Files changed https://github.com/python/devguide/pull/1844/files
Please reload this pagehttps://github.com/python/devguide/pull/1844/files
Add a note to the style guide about abbreviations https://github.com/python/devguide/pull/1844/files#top
Show all changes 7 commits https://github.com/python/devguide/pull/1844/files
5e900e3 Add a note to the style guide about abbreviations sirosen Jun 26, 2026 https://github.com/python/devguide/pull/1844/commits/5e900e337e21d1d5d39d35e3701035a3387058ea
3b5d5b5 Split `:abbr:` vs "acronym howto" docs go sirosen Jun 26, 2026 https://github.com/python/devguide/pull/1844/commits/3b5d5b581512e2d11022517d64c500db1dcec333
7555c40 Merge branch 'main' into add-abbreviations-to-style-guide sirosen Jul 24, 2026 https://github.com/python/devguide/pull/1844/commits/7555c4078ef32e1a20570f3c141a4c14bfdd8047
d531625 Add "In general, ..." to soften acronym note sirosen Jul 24, 2026 https://github.com/python/devguide/pull/1844/commits/d53162553c35064b8a6b2da607bfd552a0460fea
0cf8618 Update documentation/style-guide.rst sirosen Jul 25, 2026 https://github.com/python/devguide/pull/1844/commits/0cf86182da8f945618d326a7c9dd28408fe79af9
d0cdf9e Add a small note on acronyms not to expand sirosen Jul 28, 2026 https://github.com/python/devguide/pull/1844/commits/d0cdf9eb2c8d9eea29bb4873e35fee23cf6c7a61
7ac2c8f Apply fixes per review sirosen Jul 28, 2026 https://github.com/python/devguide/pull/1844/commits/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0
Clear filters https://github.com/python/devguide/pull/1844/files
Please reload this pagehttps://github.com/python/devguide/pull/1844/files
Please reload this pagehttps://github.com/python/devguide/pull/1844/files
development-cycle.rst https://github.com/python/devguide/pull/1844/files#diff-17ef388a69c90cbf44e58ce55bec2b71b067eb3a0e831693dd70d1c26e79ec77
stdlib.rst https://github.com/python/devguide/pull/1844/files#diff-4d263f0a0e4f2982eeca9e45fc16eb1de252644dfcc0ab82c12b86518b4da19d
index.rst https://github.com/python/devguide/pull/1844/files#diff-c7312dca8f4d2b64b6c16738761b88690841516453acd39b8f5e6ca68d08a95d
markup.rst https://github.com/python/devguide/pull/1844/files#diff-b87d0f4cebc0057735d5cd8add1b0dd6f4f7ddd26296692da70ed9645807b561
style-guide.rst https://github.com/python/devguide/pull/1844/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
pull-request-lifecycle.rst https://github.com/python/devguide/pull/1844/files#diff-468af235fa8bc299d43431017691dace11ba19f390ac156288086348c6f8f931
setup-building.rst https://github.com/python/devguide/pull/1844/files#diff-74b33c1ed25a2ceb1b275739a8aa69aeccc6cc859e80c40c8614045c9390cf6a
coverage.rst https://github.com/python/devguide/pull/1844/files#diff-03686fa555ac06120e9580f844926cbfc0d3ac2691d2bb46b28a433109ff66ad
developer-workflow/development-cycle.rsthttps://github.com/python/devguide/pull/1844/files#diff-17ef388a69c90cbf44e58ce55bec2b71b067eb3a0e831693dd70d1c26e79ec77
View file https://github.com/sirosen/devguide/blob/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0/developer-workflow/development-cycle.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1844/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1844/files#diff-17ef388a69c90cbf44e58ce55bec2b71b067eb3a0e831693dd70d1c26e79ec77
https://github.com/python/devguide/pull/1844/files#diff-17ef388a69c90cbf44e58ce55bec2b71b067eb3a0e831693dd70d1c26e79ec77
developer-workflow/stdlib.rsthttps://github.com/python/devguide/pull/1844/files#diff-4d263f0a0e4f2982eeca9e45fc16eb1de252644dfcc0ab82c12b86518b4da19d
View file https://github.com/sirosen/devguide/blob/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0/developer-workflow/stdlib.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1844/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1844/files#diff-4d263f0a0e4f2982eeca9e45fc16eb1de252644dfcc0ab82c12b86518b4da19d
https://github.com/python/devguide/pull/1844/files#diff-4d263f0a0e4f2982eeca9e45fc16eb1de252644dfcc0ab82c12b86518b4da19d
https://github.com/python/devguide/pull/1844/files#diff-4d263f0a0e4f2982eeca9e45fc16eb1de252644dfcc0ab82c12b86518b4da19d
https://github.com/python/devguide/pull/1844/files#diff-4d263f0a0e4f2982eeca9e45fc16eb1de252644dfcc0ab82c12b86518b4da19d
development-tools/clinic/index.rsthttps://github.com/python/devguide/pull/1844/files#diff-c7312dca8f4d2b64b6c16738761b88690841516453acd39b8f5e6ca68d08a95d
View file https://github.com/sirosen/devguide/blob/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0/development-tools/clinic/index.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1844/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1844/files#diff-c7312dca8f4d2b64b6c16738761b88690841516453acd39b8f5e6ca68d08a95d
https://github.com/python/devguide/pull/1844/files#diff-c7312dca8f4d2b64b6c16738761b88690841516453acd39b8f5e6ca68d08a95d
https://github.com/python/devguide/pull/1844/files#diff-c7312dca8f4d2b64b6c16738761b88690841516453acd39b8f5e6ca68d08a95d
documentation/markup.rsthttps://github.com/python/devguide/pull/1844/files#diff-b87d0f4cebc0057735d5cd8add1b0dd6f4f7ddd26296692da70ed9645807b561
View file https://github.com/sirosen/devguide/blob/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0/documentation/markup.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1844/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1844/files#diff-b87d0f4cebc0057735d5cd8add1b0dd6f4f7ddd26296692da70ed9645807b561
https://github.com/python/devguide/pull/1844/files#diff-b87d0f4cebc0057735d5cd8add1b0dd6f4f7ddd26296692da70ed9645807b561
documentation/style-guide.rsthttps://github.com/python/devguide/pull/1844/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
View file https://github.com/sirosen/devguide/blob/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0/documentation/style-guide.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1844/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1844/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
https://github.com/python/devguide/pull/1844/files#diff-6214c625cd8957c4d44a82e8bf690366b72572a18a40f0c7a0f88cdd099dc36c
getting-started/pull-request-lifecycle.rsthttps://github.com/python/devguide/pull/1844/files#diff-468af235fa8bc299d43431017691dace11ba19f390ac156288086348c6f8f931
View file https://github.com/sirosen/devguide/blob/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0/getting-started/pull-request-lifecycle.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1844/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1844/files#diff-468af235fa8bc299d43431017691dace11ba19f390ac156288086348c6f8f931
https://github.com/python/devguide/pull/1844/files#diff-468af235fa8bc299d43431017691dace11ba19f390ac156288086348c6f8f931
getting-started/setup-building.rsthttps://github.com/python/devguide/pull/1844/files#diff-74b33c1ed25a2ceb1b275739a8aa69aeccc6cc859e80c40c8614045c9390cf6a
View file https://github.com/sirosen/devguide/blob/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0/getting-started/setup-building.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1844/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1844/files#diff-74b33c1ed25a2ceb1b275739a8aa69aeccc6cc859e80c40c8614045c9390cf6a
https://github.com/python/devguide/pull/1844/files#diff-74b33c1ed25a2ceb1b275739a8aa69aeccc6cc859e80c40c8614045c9390cf6a
testing/coverage.rsthttps://github.com/python/devguide/pull/1844/files#diff-03686fa555ac06120e9580f844926cbfc0d3ac2691d2bb46b28a433109ff66ad
View file https://github.com/sirosen/devguide/blob/7ac2c8f0306ebfc81779f770f087cc0df6ad71d0/testing/coverage.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/devguide/pull/1844/{{ revealButtonHref }}
https://github.com/python/devguide/pull/1844/files#diff-03686fa555ac06120e9580f844926cbfc0d3ac2691d2bb46b28a433109ff66ad
https://github.com/python/devguide/pull/1844/files#diff-03686fa555ac06120e9580f844926cbfc0d3ac2691d2bb46b28a433109ff66ad
Please reload this pagehttps://github.com/python/devguide/pull/1844/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.