Add test to verify `idlelib/help.html` is in sync with docs
Open
Nobody has claimed this yet.
docs
stdlib
tests
topic-IDLE
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with Lib/idlelib/help.html and its source, Doc/library/idle.rst, then review the linked PRs gh-120571, gh-120576, and gh-120577. Determine whether the synchronization test and generated-file checks are already covered; done means the generated help file is validated against its source and the release or CI gaps are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation, testing-qa
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100