typing icon indicating copy to clipboard operation
typing copied to clipboard

Typing spec: Improve cross-linking

Open JelleZijlstra opened this issue 2 years ago • 1 comments

We should improve links within the spec. Concretely:

  • Replace links to PEPs with links to the relevant part of the spec (https://github.com/python/typing/pull/1517#pullrequestreview-1763857938)
  • Where we mention a feature, link it to the relevant spec section (e.g., whenever we mention Annotated, it should link to the spec section that describes Annotated).
  • Strategically add link targets so other Sphinx docs (e.g., docs.python.org, the PEPs) can link to the spec

This can be done in small increments, one PR at a time, and doesn't need signoff from the Typing Council. Contributions are welcome.

JelleZijlstra avatar Dec 11 '23 04:12 JelleZijlstra

#1626 did the third part but the rest is not yet done.

JelleZijlstra avatar Feb 14 '24 20:02 JelleZijlstra