python / python/cpython

Fix all Sphinx reference warnings in the documentation (meta issue)

Aperta
#151,940 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs type-bug
Lingua principale
Python
Stelle
77.2k
Fork
36k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

This supersedes the previous closed issue for this: https://github.com/python/cpython/issues/101100

I have created several sub-issues (see table below) to split the work up and avoid what happened the last time. This is the meta issue for this task, any general discussion on this topic should go here, not on the sub-issues, and vice-versa.

In each of the issues, I've added the current list of warnings. Note that the warnings themselves, and their line numbers may change.


There are some warnings that come up with no file:

TODO: Figure these out.
<unknown>:922: c:type reference target not found: PyWeakReference [ref.type]
<unknown>:956: c:data reference target not found: Py_FileSystemDefaultEncodeErrors [ref.data]
<unknown>:957: c:data reference target not found: Py_FileSystemDefaultEncoding [ref.data]
<unknown>:970: c:data reference target not found: Py_HasFileSystemDefaultEncoding [ref.data]
<unknown>:1026: c:data reference target not found: Py_UTF8Mode [ref.data]
<unknown>:1037: c:type reference target not found: Py_intptr_t [ref.type]
<unknown>:1141: c:type reference target not found: Py_uintptr_t [ref.type]
<unknown>:1168: c:type reference target not found: ssizessizeargfunc [ref.type]
<unknown>:1169: c:type reference target not found: ssizessizeobjargproc [ref.type]
<unknown>:1170: c:type reference target not found: symtable [ref.type]
Linked PRs
  • gh-153086

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 aprendo le sub-issue referenziate nella meta issue e rivedendo i relativi elenchi di avvisi attuali; gli avvisi e i numeri di riga possono cambiare. Esamina gli avvisi di riferimento elencati, incluse le destinazioni senza file, e considera il lavoro completato quando la build della documentazione Sphinx non segnala più avvisi di riferimento.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.