python / python/cpython

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

オープン
#120,360 コメント 9 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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. リポジトリをフォークし、ブランチを切って変更します。
  4. 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 を短くまとめたダイジェスト。