Doc: Glossary alphabetic order is only for English
Chưa có ai nhận issue này.
- 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
Nowadays, the glossary is kept in alphabetical order manually. Here we have two problems:
- Eventually, the entry order is wrong ( Glossary: locale order )
- The alphabetical order is kept just in English.
I propose using Sphinx :sorted: option. The glossary will always be ordered in all languages. The two problems above will be solved.
Collateral effects:
- The two first current entry will change (>>> … → … >>>)
- Dunder entries will appear before the letter a.
I think the benefits are bigger than the collateral effects. Besides, it is so easy to implement.
Discus topic: https://discuss.python.org/t/glossary-alphabetically-ordering-for-all-language/101778/1
Linked PRs
- gh-138708
- gh-138711
- gh-142640
- gh-150174
- gh-150321
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với định nghĩa Sphinx của bảng thuật ngữ và xem xét tùy chọn :sorted: được mô tả trong issue. Áp dụng tùy chọn này để bảng thuật ngữ được sắp xếp cho từng ngôn ngữ, bao gồm các thay đổi được ghi lại đối với những mục đầu tiên và vị trí của các tên dunder. Build tài liệu và kiểm tra bảng thuật ngữ được tạo ở nhiều ngôn ngữ.
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ó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 25/100