Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Typing spec: Improve cross-linking #1531

Open
JelleZijlstra opened this issue Dec 11, 2023 · 1 comment
Open

Typing spec: Improve cross-linking #1531

JelleZijlstra opened this issue Dec 11, 2023 · 1 comment
Labels
topic: documentation Documentation-related issues and PRs topic: typing spec For improving the typing spec

Comments

@JelleZijlstra
Copy link
Member

We should improve links within the spec. Concretely:

  • Replace links to PEPs with links to the relevant part of the spec (Add the typing spec #1517 (review))
  • 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 JelleZijlstra added topic: documentation Documentation-related issues and PRs topic: typing spec For improving the typing spec labels Dec 11, 2023
@JelleZijlstra JelleZijlstra mentioned this issue Dec 11, 2023
Closed
16 tasks
@JelleZijlstra
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
topic: documentation Documentation-related issues and PRs topic: typing spec For improving the typing spec
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JelleZijlstra and others