Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Typing spec: Improve cross-linking

Aperta
#1,531 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
42/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia esaminando la typing spec collegata, in particolare la pagina sul sistema dei tipi e il pull request di riferimento. Individua un piccolo gruppo di riferimenti a PEP o feature da aggiornare, quindi verifica che le sezioni rilevanti della spec siano collegate e che tutte le destinazioni dei link aggiunte vengano risolte correttamente nella documentazione generata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

topic: documentation topic: typing spec

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.

Lingua principale
Python
Stelle
1.8k
Fork
302
Merge medio
23h
PR unite (30g)
8

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di python/typing

Tutte le issue di python/typing

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.