gh-100557: Clarify signal.pause() docs to explain it only wakes on handled signals#148723
Open
EoinTrial wants to merge 2 commits intopython:mainfrom
Open
gh-100557: Clarify signal.pause() docs to explain it only wakes on handled signals#148723EoinTrial wants to merge 2 commits intopython:mainfrom
EoinTrial wants to merge 2 commits intopython:mainfrom
Conversation
…alueError and IndexError
… on handled signals
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The current docs for
signal.pause()state only "Wait until a signal arrives." This is incomplete to the point of being wrong:pause(2)only returns control if a signal is delivered that has a handler installed. Signals that are being ignored do not interruptpause().This PR updates the Clinic docstring in
Modules/signalmodule.c(and the generatedModules/clinic/signalmodule.c.h) to accurately describe this behaviour.Note: the
input=hash in the[clinic end generated code]comment will need to be updated by runningmake clinicbefore merging.signal.pauseis incorrect #100557📚 Documentation preview 📚: https://cpython-previews--148723.org.readthedocs.build/