Use footnotes for numbered notes in tables
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 36k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
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
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pelas tabelas de códigos de formato na documentação de datetime e compare o estilo de notas numeradas delas com as notas de rodapé já usadas em collections.abc. Converta as notas relevantes em notas de rodapé do Sphinx quando isso ajudar na navegação, preservando o conteúdo das notas e o significado das tabelas; gh-137743 indica que o trabalho relacionado já está em andamento.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 25/100