Document the various code generation tools used by CPython
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.1k
- Forks
- 1k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 12
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Überprüfe den bestehenden Abschnitt „Guide to CPython's Parser“ und die aufgeführten Tools: freeze_modules.py, deepfreeze.py und generate_global_objects.py. Ermittle, ob die Dokumentation in den devguide oder in die CPython-Dokumentation gehört, und dokumentiere anschließend Zweck und Aufruf jedes Tools sowie die zugehörigen make targets, mit Links zu Parser-Generatoren, wo dies angebracht ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- build-system, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100