python / python/cpython

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

Abierto
#120,360 9 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs stdlib tests topic-IDLE
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con Lib/idlelib/help.html y su fuente, Doc/library/idle.rst, y luego revisa los PRs enlazados gh-120571, gh-120576 y gh-120577. Determina si la prueba de sincronización y las comprobaciones de archivos generados ya están cubiertas; se considera terminado cuando el archivo de ayuda generado se valida con respecto a su fuente y se abordan las carencias del release o de la CI.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
build-system, documentation, testing-qa
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.