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
Domain: github.com
{"@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-profiling | 0 |
| react-import-map | react,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-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:133ecf55-fda2-e248-049a-0e9c83d95f60 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | ABA2:F7C4C:355CD78:476FC93:6B021092 |
| html-safe-nonce | c6c558104381dc412fbcc5b6ccb4e331d2adffe0e2cdf9725676dec085c85e10 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBQkEyOkY3QzRDOjM1NUNENzg6NDc2RkM5Mzo2QjAyMTA5MiIsInZpc2l0b3JfaWQiOiIxNDc4NTAxMTkzMDM3Nzc5MDkwIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 6eebcc2ea05224ddf5a9f89384f877d26a845a8670554d53436b7dadcc9b9edb |
| hovercard-subject-tag | issue:1327838543 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/devguide/927/issue_layout |
| twitter:image | https://opengraph.githubassets.com/ddfdceb615554bb9e6bb6b132caab186da993f4ae289309e8d64dc8a3b11bea1/python/devguide/issues/927 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/ddfdceb615554bb9e6bb6b132caab186da993f4ae289309e8d64dc8a3b11bea1/python/devguide/issues/927 |
| og:image:alt | 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... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | CAM-Gerlach |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/devguide git https://github.com/python/devguide.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 63972479 |
| octolytics-dimension-repository_nwo | python/devguide |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 63972479 |
| octolytics-dimension-repository_network_root_nwo | python/devguide |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width