Document the various code generation tools used by CPython

Aperta
#805 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Esamina la sezione esistente «Guide to CPython's Parser» e gli strumenti elencati: freeze_modules.py, deepfreeze.py e generate_global_objects.py. Determina se la documentazione appartiene al devguide o alla documentazione di CPython, quindi documenta lo scopo, l’invocazione e i make targets correlati di ogni strumento, includendo link ai parser generator dove appropriato.

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

Descrizione

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

Lingua principale
Python
Stelle
2.1k
Fork
1k
Merge medio
2g 12h
PR unite (30g)
12

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.

Altre issue di python/devguide

Tutte le issue di python/devguide

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.