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

Convert PEP 630 (Isolating Extension Modules) to "HOWTO" #94489

Merged
merged 3 commits into from
Jul 5, 2022

Conversation

encukou
Copy link
Member

@encukou encukou commented Jul 1, 2022

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 :)

Copy link
Member

@AlexWaygood AlexWaygood left a 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!

@bskinn
Copy link
Contributor

bskinn commented Jul 1, 2022

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.

@CAM-Gerlach CAM-Gerlach self-requested a review July 2, 2022 03:52
@CAM-Gerlach
Copy link
Member

Likewise, I've read it, but due to the length I'll need to save my full review comments for another day, hopefully tomorrow.

@bskinn
Copy link
Contributor

bskinn commented Jul 2, 2022

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.)

@encukou
Copy link
Member Author

encukou commented Jul 4, 2022

who is the target audience?

Yes, experienced extension developers – ones currently maintaining extensions.
I'm painfully aware we don't currently have docs to onboard people to this level. My longer-term plan is to change the extending/embedding tutorial to guide peuple to a point where they don't need a “how to switch to the new way” guide.

encukou and others added 2 commits July 4, 2022 11:20
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@ambv
Copy link
Contributor

ambv commented Jul 5, 2022

This is awesome. Let's have it as is and backport to 3.11 as well. We can iterate on the content after.

@ambv ambv added the needs backport to 3.11 only security fixes label Jul 5, 2022
@ambv ambv merged commit e6ec6f5 into python:main Jul 5, 2022
@miss-islington
Copy link
Contributor

Thanks @encukou for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-94566 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 5, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 5, 2022
…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>
ambv pushed a commit that referenced this pull request Jul 5, 2022
) (GH-94566)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>

(cherry picked from commit e6ec6f5)
@encukou encukou deleted the isolating-howto branch July 7, 2022 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants