GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Clarify best practices with ref target labels in docs · Issue #927 · python/devguide

Clarify best practices with ref target labels in docs #927

New issue
Copy link
New issue
Copy link
Open
Open
Clarify best practices with ref target labels in docs#927
Copy link
Assignees
CAM-Gerlach
Labels
topic-documentationtype-featureAdditions; New content or section neededAdditions; New content or section needed

Description

@CAM-Gerlach
CAM-Gerlach
opened on Aug 3, 2022
Issue body actions

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 in the Cross-linking markup section.

Specifically, 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).

Also, 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.

If we agree this would be helpful, I can submit a PR on this once #916 is merged.

Reacted by Ezio Melotti and Erlend E. Aasland

Activity

  1. CAM-Gerlach
    added
    type-featureAdditions; New content or section neededAdditions; New content or section needed
    on Aug 3, 2022
  2. CAM-Gerlach
    self-assigned this
    on Aug 3, 2022
  3. willingc
    added
    guide-new content
    type-featureAdditions; New content or section neededAdditions; New content or section needed
    and removed
    type-featureAdditions; New content or section neededAdditions; New content or section needed
    on Oct 11, 2023
  4. StanFromIreland
    added
    topic-documentation
    on Sep 13, 2025
  5. StanFromIreland
    removed
    type-feature
    on Mar 3, 2026
  6. StanFromIreland commented on May 24, 2026

    @StanFromIreland
    StanFromIreland
    on May 24, 2026
    Member
    More actions

    Specifically, 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).

    A little update: there is now a CI check for this, which will catch any such removals.

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

Metadata

Metadata

Assignees

  • @CAM-Gerlach
    CAM-Gerlach

Labels

topic-documentationtype-featureAdditions; New content or section neededAdditions; New content or section needed

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    You are visitor 01402503 — GeezerVison does not store the pages you look up.
    Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.