diff options
Diffstat (limited to 'Doc/library/threading.rst')
| -rw-r--r-- | Doc/library/threading.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index d8af157..53a72bd 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -65,8 +65,9 @@ This module defines the following functions and objects: :noindex: A factory function that returns a new event object. An event manages a flag - that can be set to true with the :meth:`set` method and reset to false with the - :meth:`clear` method. The :meth:`wait` method blocks until the flag is true. + that can be set to true with the :meth:`~Event.set` method and reset to false + with the :meth:`clear` method. The :meth:`wait` method blocks until the flag + is true. .. class:: local @@ -666,7 +667,7 @@ This is one of the simplest mechanisms for communication between threads: one thread signals an event and other threads wait for it. An event object manages an internal flag that can be set to true with the -:meth:`set` method and reset to false with the :meth:`clear` method. The +:meth:`~Event.set` method and reset to false with the :meth:`clear` method. The :meth:`wait` method blocks until the flag is true. @@ -691,13 +692,14 @@ An event object manages an internal flag that can be set to true with the .. method:: Event.clear() Reset the internal flag to false. Subsequently, threads calling :meth:`wait` - will block until :meth:`set` is called to set the internal flag to true again. + will block until :meth:`.set` is called to set the internal flag to true + again. .. method:: Event.wait([timeout]) Block until the internal flag is true. If the internal flag is true on entry, - return immediately. Otherwise, block until another thread calls :meth:`set` + return immediately. Otherwise, block until another thread calls :meth:`.set` to set the flag to true, or until the optional timeout occurs. When the timeout argument is present and not ``None``, it should be a floating |