python / python/cpython

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

Aperta
#120,360 9 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs stdlib tests topic-IDLE
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con Lib/idlelib/help.html e la relativa sorgente, Doc/library/idle.rst, quindi esamina le PR collegati gh-120571, gh-120576 e gh-120577. Determina se il test di sincronizzazione e i controlli sui file generati sono già coperti; il lavoro è terminato quando il file della guida generato viene convalidato rispetto alla sua sorgente e vengono colmate le lacune del release o della CI.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
build-system, documentation, testing-qa
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.