Description

pxeger

opened on Jan 27, 2022

Issue body actions

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 python/cpython#30941 (comment)

CC @ericisnowcurrently

Activity

1. erlend-aasland commented on Jul 15, 2023

   

   erlend-aasland

   on Jul 15, 2023

   Contributor

   More actions

   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.

   I agree. A short how-to-use-the-various-generation-tools section would be helpful to new (and existing) contributors/devs. That includes Argument Clinic; the current how-to is huge and frightening; we should definitely add an introduction to the clinic CLI to the devguide.

   Reacted by Sergey Miryanov
2. erlend-aasland commented on Jul 24, 2023

   

   erlend-aasland

   on Jul 24, 2023

   Contributor

   More actions

   See also https://discuss.python.org/t/where-should-the-argument-clinic-docs-live/30160/
3. AA-Turner commented on Sep 29, 2023

   

   AA-Turner

   on Sep 29, 2023

   Member

   More actions

   The Argument Clinic documentation now lives here!

   A

   Reacted by Erlend E. Aasland

   Reacted by Erlend E. Aasland and Patrick Reader

   Reacted by Ezio Melotti and Sergey Miryanov
4. willingc

   added

   guide-new content

   topic-dev process

   type-featureAdditions; New content or section neededAdditions; New content or section needed

   on Oct 11, 2023
5. StanFromIreland

   removed

   type-feature

   on Mar 3, 2026
6. willingc commented on Oct 27, 2026

   

   willingc

   on Oct 27, 2026

   Collaborator

   More actions

   This is a fairly old issue. I'm going to close this based on core team comments in #1943.
7. willingc

   closed this as completedon Oct 27, 2026

Issue actions