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 — Docs for some C struct members repeat the struct name · Issue #97908 · python/cpython

Docs for some C struct members repeat the struct name #97908

New issue
Copy link
New issue
Copy link
Closed
Closed
Docs for some C struct members repeat the struct name#97908
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir

Description

@encukou
encukou
opened on Oct 5, 2022
Issue body actions

The members of PyType_Spec are documented as e.g. PyType_Spec.PyType_Spec.name:
image
This makes it cumbersome to link to them.
Fixing this will probably break URLs.

Linked PRs

  • gh-97908: CAPI docs: Remove repeated struct names from member docs #100054
  • [3.12] gh-97908: CAPI docs: Remove repeated struct names from member docs (GH-100054) #105057

Activity

  1. encukou
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    on Oct 5, 2022
  2. CAM-Gerlach commented on Oct 5, 2022

    @CAM-Gerlach
    CAM-Gerlach
    on Oct 5, 2022
    Member
    More actions

    To note, in that issue the fragments visible to external links will change, unless we add ref target labels with the old name (which will generate anchors for them).

  3. encukou commented on Dec 6, 2022

    @encukou
    encukou
    on Dec 6, 2022
    MemberAuthor
    More actions

    :ref: targets will not work, since Sphinx rewrites them (converts dots to dashes &c.)
    I cant's see a better way to add old fragments than raw:: html. I guess this is HTML-specific, or at least hypertext-specific.

  4. encukou
    added a commit that references this issue on May 29, 2023

    gh-97908: CAPI docs: Remove repeated struct names from member docs (G…

    1668b41
  5. miss-islington
    added a commit that references this issue on May 29, 2023

    pythongh-97908: CAPI docs: Remove repeated struct names from member d…

    0c57463
  6. ambv
    added a commit that references this issue on Jun 5, 2023

    [3.12] gh-97908: CAPI docs: Remove repeated struct names from member …

    05b6153
  7. hauntsaninja commented on Sep 7, 2023

    @hauntsaninja
    hauntsaninja
    on Sep 7, 2023
    Contributor
    More actions

    Looks like this was completed, thanks!

  8. hauntsaninja
    closed this as completedon Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirDocumentation in the Doc dir

    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.