python / python/cpython

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

Abierto
#151,940 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs type-bug
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza abriendo las sub-issues referenciadas en la meta issue y revisando sus listas de advertencias actuales; las advertencias y los números de línea pueden cambiar. Trabaja en las advertencias de referencia enumeradas, incluidos los destinos sin archivo, y considera terminado el trabajo cuando la compilación de la documentación de Sphinx no informe de advertencias de referencia restantes.

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
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.