Use footnotes for numbered notes in tables
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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
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 mit den Tabellen der Formatcodes in der datetime-Dokumentation und vergleiche ihren Stil nummerierter Anmerkungen mit den bereits in collections.abc verwendeten Fußnoten. Wandle die relevanten Anmerkungen in Sphinx-Fußnoten um, wo die Navigation davon profitiert, und bewahre dabei den Inhalt der Anmerkungen und die Bedeutung der Tabellen; gh-137743 zeigt, dass die zugehörige Arbeit bereits im Gange ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100