Skip to content

gh-100557: Clarify signal.pause() docs to explain it only wakes on handled signals #148760

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.

Sign up for GitHub

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

Open
EoinTrial wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −2
Open

gh-100557: Clarify signal.pause() docs to explain it only wakes on handled signals #148760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Doc/library/signal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,8 +419,9 @@ The :mod:`!signal` module defines the following functions:

.. function:: pause()

Cause the process to sleep until a signal is received; the appropriate handler
will then be called. Returns nothing.
Cause the process to sleep until a signal with an installed handler is
delivered; the handler will then be called. Signals that are ignored or
set to the default action do not wake the process. Returns nothing.

.. availability:: Unix.

Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/Documentation/2026-04-18-12-38-41.gh-issue-100557.a6MWvZ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Clarify the documentation for :func:`signal.pause` to explain that it only
returns when a signal with an installed handler is delivered, not when an
ignored signal arrives.
###########################################################################
Loading