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

clarify limited API support a bit #106

Merged
merged 3 commits into from
Nov 4, 2024

Conversation

ngoldbaum
Copy link
Collaborator

No description provided.

@rgommers rgommers added the documentation Improvements or additions to documentation label Nov 4, 2024
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ngoldbaum. LGTM, just two tiny comments.

docs/porting.md Outdated
currently use the limited API to build wheels that do not depend on a specific
Python version, you will not be able to use it while shipping binaries for the
free-threaded build. In practice, the limited API is a subset of the full C API,
so your extension will almost certainly build, you just cannot set
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd drop "almost certainly", it just made me wonder about corner case scenarios that should really not exist.

docs/porting.md Outdated
Python version, you will not be able to use it while shipping binaries for the
free-threaded build. In practice, the limited API is a subset of the full C API,
so your extension will almost certainly build, you just cannot set
`Py_LIMITED_API` at build time. This also means that code inside `#ifdef Py_GIL_DISABLED` checks can use C API constructs outside the limited API if you
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: line break?

@ngoldbaum ngoldbaum merged commit 4da6476 into Quansight-Labs:main Nov 4, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants