PEP 12: Add list of intersphinx mappings
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- reStructuredText
- Sterne
- 5k
- Forks
- 1.8k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 25
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, PEP 12 und die im Issue referenzierte Sphinx-Konfiguration zu finden. Bestätige, wo die intersphinx-Zuordnungen gepflegt werden, und aktualisiere dann PEP 12 mit der Liste oder erkläre, wo Leser sie finden können; abgeschlossen bedeutet, dass die verfügbaren Zuordnungen ohne vorherige Kenntnis der Konfiguration auffindbar sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100