Typing spec: Improve cross-linking
Ouverte
Personne n'a encore pris cette issue.
topic: documentation
topic: typing spec
- Langage dominant
- Python
- Étoiles
- 1.8k
- Forks
- 302
- Merge moyen
- 23 h
- PR mergées (30 j)
- 8
Description
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 describesAnnotated). - 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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner la typing spec liée, en particulier la page sur le système de types et le pull request référencé. Identifiez un petit groupe de références à des PEP ou à des features à mettre à jour, puis vérifiez que les sections pertinentes de la spec sont liées et que toutes les cibles de liens ajoutées sont correctement résolues dans la documentation générée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100