python / python/cpython

Use footnotes for numbered notes in tables

Abierto
#137,742 4 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

Documentation

In a few places, the docs include tables with numbered notes, similar to this:

Cheese In Stock
Red Leicester no
Camembert yes (1) (2)

(1) it's a bit runny
(2) the cat's eaten it

Often the notes are written using simple numbered lists, which notably don't create links between the note references and their definitions. This can make viewing the notes somewhat tedious, particularly when the table is very long or when the same notes are shared by multiple tables.

Another way to format these notes is using Sphinx footnotes. Footnotes have the benefit of creating bi-directional links between the note entries and their references, which makes viewing a note and then navigating back to where you were much easier. The footnote definitions can be placed anywhere in the docs, so in particular they can be placed immediately after the table that references them. This is already done for a few tables in the current docs, e.g. in collections.abc.

I propose migrating some of the existing table notes to footnotes in cases where having the extra navigation links would be helpful. In particular, I think this would be useful for the format code tables in the datetime docs.

The result would look something like this:

Cheese In Stock
Red Leicester no
Camembert yes [^1] [^2]

[^1]: it's a bit runny
[^2]: the cat's eaten it

Linked PRs
  • gh-137743

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

Empieza por las tablas de códigos de formato de la documentación de datetime y compara su estilo de notas numeradas con las notas al pie que ya se usan en collections.abc. Convierte las notas pertinentes en notas al pie de Sphinx cuando eso facilite la navegación, conservando el contenido de las notas y el significado de las tablas; gh-137743 indica que el trabajo relacionado ya está en curso.

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
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.