Use footnotes for numbered notes in tables
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
datetime ドキュメントのフォーマットコード表から始め、番号付き注記のスタイルを、collections.abc ですでに使用されている脚注と比較してください。ナビゲーションに役立つ場合は、関連する注記を Sphinx の脚注に変換し、注記の内容と表の意味を維持してください。gh-137743 は、関連する作業がすでに進行中であることを示しています。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100