diff options
author | Tal Einat <taleinat@gmail.com> | 2015-05-16 11:14:49 (GMT) |
---|---|---|
committer | Tal Einat <taleinat@gmail.com> | 2015-05-16 11:14:49 (GMT) |
commit | c7027b79041524e4ff5414cf187433b3edd38ede (patch) | |
tree | 23cda74d64b6c9187d2f7929742e069c6f7fb63b /Doc/library | |
parent | 97fceee3b9c7037c1b2328fe96f58ec55eee6b85 (diff) | |
download | cpython-c7027b79041524e4ff5414cf187433b3edd38ede.zip cpython-c7027b79041524e4ff5414cf187433b3edd38ede.tar.gz cpython-c7027b79041524e4ff5414cf187433b3edd38ede.tar.bz2 |
Issue #20182: converted the signal module to use Argument Clinic
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/signal.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index 553920d..9549838 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -219,21 +219,21 @@ The :mod:`signal` module defines the following functions: :func:`sigpending`. -.. function:: pthread_kill(thread_id, signum) +.. function:: pthread_kill(thread_id, signalnum) - Send the signal *signum* to the thread *thread_id*, another thread in the + Send the signal *signalnum* to the thread *thread_id*, another thread in the same process as the caller. The target thread can be executing any code (Python or not). However, if the target thread is executing the Python interpreter, the Python signal handlers will be :ref:`executed by the main - thread <signals-and-threads>`. Therefore, the only point of sending a signal to a particular - Python thread would be to force a running system call to fail with - :exc:`InterruptedError`. + thread <signals-and-threads>`. Therefore, the only point of sending a + signal to a particular Python thread would be to force a running system call + to fail with :exc:`InterruptedError`. Use :func:`threading.get_ident()` or the :attr:`~threading.Thread.ident` attribute of :class:`threading.Thread` objects to get a suitable value for *thread_id*. - If *signum* is 0, then no signal is sent, but error checking is still + If *signalnum* is 0, then no signal is sent, but error checking is still performed; this can be used to check if the target thread is still running. Availability: Unix (see the man page :manpage:`pthread_kill(3)` for further |