Typing spec: Improve cross-linking
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 1.8k
- Forks
- 302
- Merge medio
- 23 h
- PR fusionados (30 d)
- 8
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando la typing spec enlazada, especialmente la página del sistema de tipos y el pull request referenciado. Identifica un grupo pequeño de referencias a PEP o features que deban actualizarse y, después, verifica que las secciones relevantes de la spec estén enlazadas y que todos los destinos de enlace añadidos se resuelvan correctamente en la documentación generada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100