summaryrefslogtreecommitdiffstats
path: root/Doc/library/signal.rst
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2012-03-02 21:54:03 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2012-03-02 21:54:03 (GMT)
commit643cd68ea4b8d33a6d0163ef693ef6518f76b88f (patch)
tree4dda5f7783635633cc2d092dd975461ba263d2c0 /Doc/library/signal.rst
parent1c13f84f5554cecbdce8bf42dbfb609c1f72282a (diff)
downloadcpython-643cd68ea4b8d33a6d0163ef693ef6518f76b88f.zip
cpython-643cd68ea4b8d33a6d0163ef693ef6518f76b88f.tar.gz
cpython-643cd68ea4b8d33a6d0163ef693ef6518f76b88f.tar.bz2
Issue #13964: signal.sigtimedwait() timeout is now a float instead of a tuple
Add a private API to convert an int or float to a C timespec structure.
Diffstat (limited to 'Doc/library/signal.rst')
-rw-r--r--Doc/library/signal.rst9
1 files changed, 4 insertions, 5 deletions
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst
index 4fc3fd6..04afd9e 100644
--- a/Doc/library/signal.rst
+++ b/Doc/library/signal.rst
@@ -369,12 +369,11 @@ The :mod:`signal` module defines the following functions:
.. versionadded:: 3.3
-.. function:: sigtimedwait(sigset, (timeout_sec, timeout_nsec))
+.. function:: sigtimedwait(sigset, timeout)
- Like :func:`sigtimedwait`, but takes a tuple of ``(seconds, nanoseconds)``
- as an additional argument specifying a timeout. If both *timeout_sec* and
- *timeout_nsec* are specified as :const:`0`, a poll is performed. Returns
- :const:`None` if a timeout occurs.
+ Like :func:`sigwaitinfo`, but takes an additional *timeout* argument
+ specifying a timeout. If *timeout* is specified as :const:`0`, a poll is
+ performed. Returns :const:`None` if a timeout occurs.
Availability: Unix (see the man page :manpage:`sigtimedwait(2)` for further
information).