Document the various code generation tools used by CPython

Aberta
#805 3 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
45/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
build-system, documentation

Direção de pesquisa

Revise a seção existente “Guide to CPython's Parser” e as ferramentas listadas: freeze_modules.py, deepfreeze.py e generate_global_objects.py. Determine se a documentação deve ficar no devguide ou na documentação do CPython e, em seguida, documente a finalidade, a invocação e os make targets relacionados de cada ferramenta, incluindo links para geradores de parser quando apropriado.

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

Descrição

topic-dev process type-feature

Describe the enhancement or feature you'd like

There should be some documentation about the various code generation tools used in CPython, for example:

  • freeze_modules.py
  • deepfreeze.py
  • generate_global_objects.py

I don't think there needs to be a massive amount of documentation about these. Just a brief mention of their purposes, how to invoke them, and notes about their related make targets.

Related are the Parser generator etc., which are already documented under Guide to CPython's Parser, but could also be mentioned. I think their existing docs could also be used as something of a template.

Describe alternatives you've considered

Argument clinic is already documented at https://docs.python.org/3/howto/clinic.html so maybe this documentation would be more appropriate in the main Python repo's docs? I'll defer to the devguide maintainers on this.

Additional context

Started from a conversation at https://github.com/python/cpython/pull/30941#issuecomment-1023501086

CC @ericisnowcurrently

Linguagem predominante
Python
Estrelas
2.1k
Forks
1k
Merge médio
2d 12h
PRs com merge (30d)
12

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.

Mais de python/devguide

Todas as issues de python/devguide

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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