Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the various code generation tools used by CPython #805

Open
pxeger opened this issue Jan 27, 2022 · 3 comments
Open

Document the various code generation tools used by CPython #805

pxeger opened this issue Jan 27, 2022 · 3 comments
Labels
enhancement guide-new content Additions; New content or section needed topic-dev process

Comments

@pxeger
Copy link

pxeger commented Jan 27, 2022

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

@erlend-aasland
Copy link
Contributor

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.

@erlend-aasland
Copy link
Contributor

See also https://discuss.python.org/t/where-should-the-argument-clinic-docs-live/30160/

@AA-Turner
Copy link
Member

The Argument Clinic documentation now lives here!

A

@willingc willingc added guide-new content Additions; New content or section needed topic-dev process enhancement labels Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement guide-new content Additions; New content or section needed topic-dev process
Projects
None yet
Development

No branches or pull requests

4 participants