python / python/cpython

Add test to verify `idlelib/help.html` is in sync with docs

未关闭
#120,360 9 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs stdlib tests topic-IDLE
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

Bug report

There are multiple problems with it:

  1. 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
  2. Is is not rebuilt / executed during release process
  3. It is not executed to check that generated files are up-to-date with the source ones (Doc/library/idle.rst in this case) in CI
  4. help.html does not contain a comment that it is generated (and from what)
  5. help.html is 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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 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

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。