-
-
Notifications
You must be signed in to change notification settings - Fork 33.4k
gh-141004: Document PyOS_InterruptOccurred
#141526
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
base: main
Are you sure you want to change the base?
gh-141004: Document PyOS_InterruptOccurred
#141526
Conversation
ZeroIntensity
left a comment
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.
Nearly there!
| This function is async-signal-safe and this function cannot fail. | ||
| The caller must hold an :term:`attached thread state`. |
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.
Usually, these go at the bottom, but I'll leave it up to you.
| Returns ``1`` if a :c:macro:`!SIGINT` has occurred and clears the signal flag, | ||
| or ``0`` otherwise. |
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 like it more when there's separation between the abstract description and the details.
| Returns ``1`` if a :c:macro:`!SIGINT` has occurred and clears the signal flag, | |
| or ``0`` otherwise. | |
| Returns ``1`` if a :c:macro:`!SIGINT` has occurred and clears the signal flag, | |
| or ``0`` otherwise. |
📚 Documentation preview 📚: https://cpython-previews--141526.org.readthedocs.build/