-
-
Notifications
You must be signed in to change notification settings - Fork 31.5k
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
Convert PEP 630 (Isolating Extension Modules) to "HOWTO" #94489
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I skim-read, but here's a few small comments!
I read the whole thing to orient myself. I'll have comments and suggestions, once I have a chance to write them out. End of day Monday at latest, I think. |
Likewise, I've read it, but due to the length I'll need to save my full review comments for another day, hopefully tomorrow. |
High level question: who is the target audience? Only experienced C extension developers? Experienced and learning Cext developers? Where is this document going to be referred to, elsewhere in the docs, and who is that likely to draw to the page? Right now this feels written only toward experienced extension developers. This is fine, if that's the goal! But IMO the audience should be stated up front. And, if possible, links to other resources for people who aren't the target audience should be provided. (If the audience is experienced extension devs, say, then link(s) to getting-started resources for C extensions.) |
Yes, experienced extension developers – ones currently maintaining extensions. |
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This is awesome. Let's have it as is and backport to 3.11 as well. We can iterate on the content after. |
GH-94566 is a backport of this pull request to the 3.11 branch. |
…nGH-94489) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit e6ec6f5) Co-authored-by: Petr Viktorin <encukou@gmail.com>
As per PEP-687, the informational PEP-630 is moved to the docs as a HOWTO.
It's not really a Diátaxis-style How-to guide -- it's more of an Explanation with instructions thrown in. I'm not sure how to split it without spending weeks on it. (FWIW I think the time I can dedicate to this would be better spent on the Tutorial.)
@python/proofreaders, suggestions welcome – anything from typo fixes to complete restructuring :)