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

Docs: misleading availability note for PyOS_CheckStack #91815

Closed
encukou opened this issue Apr 22, 2022 · 1 comment
Closed

Docs: misleading availability note for PyOS_CheckStack #91815

encukou opened this issue Apr 22, 2022 · 1 comment
Labels
docs Documentation in the Doc dir expert-C-API OS-windows

Comments

@encukou
Copy link
Member

encukou commented Apr 22, 2022

PyOS_CheckStack docs currently say it's only available when USE_STACKCHECK is defined (currently on Windows using the Microsoft Visual C++ compiler).

However, according to the code, it's only available on 32-bit Windows, and has some other restrictions that might or might not be relevant today.

The note should not imply that all MSVC Windows builds have the macro. It should say something like “certain versions of Windows” or “Windows for certain platforms”.

@encukou encukou added docs Documentation in the Doc dir OS-windows expert-C-API labels Apr 22, 2022
@encukou
Copy link
Member Author

encukou commented Apr 22, 2022

Fixed in #91816

@encukou encukou closed this as completed Apr 22, 2022
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 expert-C-API OS-windows
Projects
None yet
Development

No branches or pull requests

1 participant