diff options
| author | Victor Stinner <victor.stinner@haypocalc.com> | 2011-05-30 21:02:52 (GMT) |
|---|---|---|
| committer | Victor Stinner <victor.stinner@haypocalc.com> | 2011-05-30 21:02:52 (GMT) |
| commit | 2a12974bca2433eea0131d904a423ed8234dcf7a (patch) | |
| tree | e238e53c319beb8f913e3411fa91a98504d1743d /Doc/library/signal.rst | |
| parent | d976098e3bb53b9c52d55a303e1389a102ed8bae (diff) | |
| download | cpython-2a12974bca2433eea0131d904a423ed8234dcf7a.zip cpython-2a12974bca2433eea0131d904a423ed8234dcf7a.tar.gz cpython-2a12974bca2433eea0131d904a423ed8234dcf7a.tar.bz2 | |
Close #12028: Make threading._get_ident() public, rename it to
threading.get_ident() and document it. This function was used by
_thread.get_ident().
Diffstat (limited to 'Doc/library/signal.rst')
| -rw-r--r-- | Doc/library/signal.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index 68a5d2c..f2a37cc 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -187,10 +187,9 @@ The :mod:`signal` module defines the following functions: Send the signal *signum* to the thread *thread_id*, another thread in the same process as the caller. The signal is asynchronously directed to thread. - *thread_id* can be read from the :attr:`~threading.Thread.ident` attribute - of :attr:`threading.Thread`. For example, - ``threading.current_thread().ident`` gives the identifier of the current - thread. + Use :func:`threading.get_ident()` or the :attr:`~threading.Thread.ident` + attribute of :attr:`threading.Thread` to get a 'thread identifier' for + *thread_id*. If *signum* is 0, then no signal is sent, but error checking is still performed; this can be used to check if a thread is still running. |