Add test to verify `idlelib/help.html` is in sync with docs
Offen
Dieses Issue hat noch niemand übernommen.
docs
stdlib
tests
topic-IDLE
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit Lib/idlelib/help.html und seiner Quelle, Doc/library/idle.rst, und prüfe anschließend die verknüpften PRs gh-120571, gh-120576 und gh-120577. Ermittle, ob der Synchronisationstest und die Prüfungen für generierte Dateien bereits abgedeckt sind; als erledigt gilt die Aufgabe, wenn die generierte Hilfedatei anhand ihrer Quelle validiert wird und die Lücken beim Release oder in der CI behoben sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- build-system, documentation, testing-qa
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100