Add test to verify `idlelib/help.html` is in sync with docs
未關閉
還沒有人認領這個 Issue。
docs
stdlib
tests
topic-IDLE
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- PR 合併指標
- PR 指標待擷取
描述
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
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
先從 Lib/idlelib/help.html 及其來源檔案 Doc/library/idle.rst 開始,然後檢視連結的 PR gh-120571、gh-120576 和 gh-120577。確認同步測試和產生檔案檢查是否已涵蓋;完成的條件是根據其來源驗證產生的說明檔,並處理 release 或 CI 的缺口。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- build-system, documentation, testing-qa
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100