Skip to content

Commit bc46cdb

Browse files
committed
gh-100557: Clarify signal.pause() docs to explain it only wakes on handled signals
1 parent 2a07ff9 commit bc46cdb

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

Doc/library/signal.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -419,8 +419,9 @@ The :mod:`!signal` module defines the following functions:
419419

420420
.. function:: pause()
421421

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

425426
.. availability:: Unix.
426427

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Clarify the documentation for :func:`signal.pause` to explain that it only
2+
returns when a signal with an installed handler is delivered, not when an
3+
ignored signal arrives.
4+
###########################################################################

0 commit comments

Comments
 (0)