python / python/cpython

Use footnotes for numbered notes in tables

Đang mở
#137,742 4 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

docs type-feature
Ngôn ngữ chính
Python
Star
77.2k
Fork
35.9k
Chỉ số merge pull request
Chỉ số pull request đang chờ

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với các bảng mã định dạng trong tài liệu datetime và so sánh kiểu chú thích được đánh số của chúng với các chú thích cuối trang đã được sử dụng trong collections.abc. Chuyển các chú thích liên quan thành chú thích cuối trang Sphinx khi việc đó giúp điều hướng, đồng thời giữ nguyên nội dung chú thích và ý nghĩa của bảng; gh-137743 cho biết công việc liên quan đã được tiến hành.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.