python / python/cpython

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

Aberta
#120,360 9 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs stdlib tests topic-IDLE
Linguagem predominante
Python
Estrelas
77.2k
Forks
35.9k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece com Lib/idlelib/help.html e sua fonte, Doc/library/idle.rst, e depois revise os PRs vinculados gh-120571, gh-120576 e gh-120577. Determine se o teste de sincronização e as verificações de arquivos gerados já estão cobertos; considera-se concluído quando o arquivo de ajuda gerado é validado em relação à sua fonte e as lacunas do release ou da CI são resolvidas.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
build-system, documentation, testing-qa
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.