René's URL Explorer Experiment


Title: Clarify best practices with ref target labels in docs · Issue #927 · python/devguide · GitHub

Open Graph Title: Clarify best practices with ref target labels in docs · Issue #927 · python/devguide

X Title: Clarify best practices with ref target labels in docs · Issue #927 · python/devguide

Description: On python/cpython#94636 , specifically python/cpython#94636 (comment) , @ezio-melotti , @erlend-aasland and I discussed that that it might be helpful to clarify in the devguide some additional guidance related to reference target labels ...

Open Graph Description: On python/cpython#94636 , specifically python/cpython#94636 (comment) , @ezio-melotti , @erlend-aasland and I discussed that that it might be helpful to clarify in the devguide some additional guid...

X Description: On python/cpython#94636 , specifically python/cpython#94636 (comment) , @ezio-melotti , @erlend-aasland and I discussed that that it might be helpful to clarify in the devguide some additional guid...

Opengraph URL: https://github.com/python/devguide/issues/927

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Clarify best practices with ref target labels in docs","articleBody":"On python/cpython#94636 , specifically https://github.com/python/cpython/pull/94636#discussion_r934008442 , @ezio-melotti , @erlend-aasland and I discussed that that it might be helpful to clarify in the devguide some additional guidance related to reference target labels in the [Cross-linking markup](https://devguide.python.org/documentation/markup/#cross-linking-markup) section.\r\n\r\nSpecifically, it could mention that whenever possible, the existing ref target should be left place (either instead of or addition to adding a new one) when sections are changed or moved, since it ensures any inbound internal or Intersphinx references don't break or need to be changed, as well as any external links that anchor (provided that it wasn't moved to a different page without a redirection). \r\n\r\nAlso, it could provide a guideline and examples on how ref labels should be \"namespaced\" to avoid conflicts, i.e. by the module name for library docs, or the page name elsewhere, documenting existing (if not always consistent) convention.\r\n\r\nIf we agree this would be helpful, I can submit a PR on this once #916 is merged.","author":{"url":"https://github.com/CAM-Gerlach","@type":"Person","name":"CAM-Gerlach"},"datePublished":"2022-08-03T22:07:08Z","url":"https://github.com/python/devguide/issues/927"}

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/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:133ecf55-fda2-e248-049a-0e9c83d95f60
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idABA2:F7C4C:355CD78:476FC93:6B021092
html-safe-noncec6c558104381dc412fbcc5b6ccb4e331d2adffe0e2cdf9725676dec085c85e10
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBQkEyOkY3QzRDOjM1NUNENzg6NDc2RkM5Mzo2QjAyMTA5MiIsInZpc2l0b3JfaWQiOiIxNDc4NTAxMTkzMDM3Nzc5MDkwIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac6eebcc2ea05224ddf5a9f89384f877d26a845a8670554d53436b7dadcc9b9edb
hovercard-subject-tagissue:1327838543
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/devguide/927/issue_layout
twitter:imagehttps://opengraph.githubassets.com/ddfdceb615554bb9e6bb6b132caab186da993f4ae289309e8d64dc8a3b11bea1/python/devguide/issues/927
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/ddfdceb615554bb9e6bb6b132caab186da993f4ae289309e8d64dc8a3b11bea1/python/devguide/issues/927
og:image:altOn python/cpython#94636 , specifically python/cpython#94636 (comment) , @ezio-melotti , @erlend-aasland and I discussed that that it might be helpful to clarify in the devguide some additional guid...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameCAM-Gerlach
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
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-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python/devguide/issues/927#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fdevguide%2Fissues%2F927
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%2Fissues%2F927
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python%2Fdevguide
Reloadhttps://github.com/python/devguide/issues/927
Reloadhttps://github.com/python/devguide/issues/927
Reloadhttps://github.com/python/devguide/issues/927
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
https://github.com/python/devguide
New issuehttps://github.com/login?return_to=https://github.com/python/devguide/issues/927
New issuehttps://github.com/login?return_to=https://github.com/python/devguide/issues/927
Clarify best practices with ref target labels in docshttps://github.com/python/devguide/issues/927#top
https://github.com/CAM-Gerlach
topic-documentationhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22topic-documentation%22
type-featureAdditions; New content or section neededhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-feature%22
https://github.com/CAM-Gerlach
CAM-Gerlachhttps://github.com/CAM-Gerlach
on Aug 3, 2022https://github.com/python/devguide/issues/927#issue-1327838543
python/cpython#94636https://github.com/python/cpython/pull/94636
python/cpython#94636 (comment)https://github.com/python/cpython/pull/94636#discussion_r934008442
@ezio-melottihttps://github.com/ezio-melotti
@erlend-aaslandhttps://github.com/erlend-aasland
Cross-linking markuphttps://devguide.python.org/documentation/markup/#cross-linking-markup
#916https://github.com/python/devguide/pull/916
CAM-Gerlachhttps://github.com/CAM-Gerlach
type-featureAdditions; New content or section neededhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-feature%22
on Aug 3, 2022https://github.com/python/devguide/issues/927#event-7123064447
CAM-Gerlachhttps://github.com/CAM-Gerlach
on Aug 3, 2022https://github.com/python/devguide/issues/927#event-7123064490
willingchttps://github.com/willingc
guide-new contenthttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22guide-new%20content%22
type-featureAdditions; New content or section neededhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-feature%22
type-featureAdditions; New content or section neededhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-feature%22
on Oct 11, 2023https://github.com/python/devguide/issues/927#event-10615455022
StanFromIrelandhttps://github.com/StanFromIreland
topic-documentationhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22topic-documentation%22
on Sep 13, 2025https://github.com/python/devguide/issues/927#event-19675347338
StanFromIrelandhttps://github.com/StanFromIreland
type-featurehttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-feature%22
on Mar 3, 2026https://github.com/python/devguide/issues/927#event-23236989254
https://github.com/StanFromIreland
StanFromIrelandhttps://github.com/StanFromIreland
on May 24, 2026https://github.com/python/devguide/issues/927#issuecomment-4529571074
Sign up for freehttps://github.com/signup?return_to=https://github.com/python/devguide/issues/927
Sign in to commenthttps://github.com/login?return_to=https://github.com/python/devguide/issues/927
CAM-Gerlachhttps://github.com/CAM-Gerlach
topic-documentationhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22topic-documentation%22
type-featureAdditions; New content or section neededhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-feature%22
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.