python / python/peps

PEP 12: Add list of intersphinx mappings

Aperta
#4,610 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
reStructuredText
Stelle
5k
Fork
1.8k
Merge medio
2g 4h
PR unite (30g)
25

Descrizione

PEP 12 is very helpful in writing PEPs and has a section on intersphinx. However, to know the available intersphinx mappings, one has to know where to look in the sphinx configuration.

I think it would be useful to include the list directly in PEP 12.

Alternatively, if that is considered to be at too high a risk for getting outdated, one could add an explanation on where to find it.

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia individuando PEP 12 e la configurazione di Sphinx a cui si fa riferimento nell’issue. Conferma dove vengono mantenute le mappature di intersphinx, quindi aggiorna PEP 12 con l’elenco oppure spiega dove i lettori possono trovarlo; il lavoro è completato quando le mappature disponibili sono individuabili senza conoscere previamente la configurazione.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.