Add test to verify `idlelib/help.html` is in sync with docs
Đang mở
Chưa có ai nhận issue này.
docs
stdlib
tests
topic-IDLE
- 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ả
Bug report
There are multiple problems with it:
- It mentions outdated Python version: https://github.com/python/cpython/blob/0335662fe1f663fe96e3e4acf0f34c5959d06b00/Lib/idlelib/help.html#L8 Right now it should be
Python 3.14a0 - Is is not rebuilt / executed during release process
- It is not executed to check that generated files are up-to-date with the source ones (
Doc/library/idle.rstin this case) in CI help.htmldoes not contain a comment that it is generated (and from what)help.htmlis not marked as generated in.gitattributes
CC @terryjreedy
Found while reviewing https://github.com/python/cpython/pull/120338#pullrequestreview-2111016950
Linked PRs
- gh-120571
- gh-120576
- gh-120577
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 Lib/idlelib/help.html và mã nguồn của nó, Doc/library/idle.rst, sau đó xem xét các PR được liên kết gh-120571, gh-120576 và gh-120577. Xác định xem bài kiểm tra đồng bộ hóa và các bước kiểm tra tệp được tạo đã được bao phủ hay chưa; được xem là hoàn tất khi tệp trợ giúp được tạo được xác thực dựa trên mã nguồn của nó và các thiếu sót trong release hoặc CI đã được xử lý.
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
- build-system, documentation, testing-qa
- Loại issue
- Lỗi
- Độ 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