gh-100557: Clarify signal.pause() docs to explain it only wakes on handled signals#148760
Open
EoinTrial wants to merge 1 commit intopython:mainfrom
Open
gh-100557: Clarify signal.pause() docs to explain it only wakes on handled signals#148760EoinTrial wants to merge 1 commit intopython:mainfrom
EoinTrial wants to merge 1 commit intopython:mainfrom
Conversation
… on handled signals
picnixz
reviewed
Apr 20, 2026
| @@ -0,0 +1,4 @@ | |||
| Clarify the documentation for :func:`signal.pause` to explain that it only | |||
Member
There was a problem hiding this comment.
You can remove the NEWS entry I will add a skip news label
picnixz
reviewed
Apr 20, 2026
Member
picnixz
left a comment
picnixz
left a comment
There was a problem hiding this comment.
I do not think there is a need for a change actually. The docs are actually already clear as they mention that we wait until a handler is called.
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
2 participants
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 docs for
signal.pause()say it sleeps "until a signal is received", which is ambiguous. Signals that are ignored or set to the default action do not wake the process, only signals with an installed handler do this.This clarifies the content in
Doc/library/signal.rstaccordingly.The C docstring in
signalmodule.cis intentionally left unchanged as it is the short manpage description and the online docs are the appropriate place for this level of detail.Fixes #100557
signal.pauseis incorrect #100557📚 Documentation preview 📚: https://cpython-previews--148760.org.readthedocs.build/