summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetri Lehtinen <petri@digip.org>2011-11-12 19:23:46 (GMT)
committerPetri Lehtinen <petri@digip.org>2011-11-12 19:24:37 (GMT)
commit2515c4d34e2206a7eccd5706eb8cd345323f798f (patch)
tree6b798303cddddac3d969c41e702cc383eb6ed4fa
parentc153cd3d5a08da96d84e83c408033d5793943496 (diff)
parentd44af82e62998e938dd60ff2bb70ecd6d7d52c05 (diff)
downloadcpython-2515c4d34e2206a7eccd5706eb8cd345323f798f.zip
cpython-2515c4d34e2206a7eccd5706eb8cd345323f798f.tar.gz
cpython-2515c4d34e2206a7eccd5706eb8cd345323f798f.tar.bz2
Merge heads
-rw-r--r--Doc/library/threading.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index 1f1d775..c226dd4 100644
--- a/Doc/library/threading.rst
+++ b/Doc/library/threading.rst
@@ -634,20 +634,21 @@ the call as often as necessary.
.. versionadded:: 3.2
- .. method:: notify()
+ .. method:: notify(n=1)
- Wake up a thread waiting on this condition, if any. If the calling thread
- has not acquired the lock when this method is called, a
+ By default, wake up one thread waiting on this condition, if any. If the
+ calling thread has not acquired the lock when this method is called, a
:exc:`RuntimeError` is raised.
- This method wakes up one of the threads waiting for the condition
- variable, if any are waiting; it is a no-op if no threads are waiting.
+ This method wakes up at most *n* of the threads waiting for the condition
+ variable; it is a no-op if no threads are waiting.
- The current implementation wakes up exactly one thread, if any are
- waiting. However, it's not safe to rely on this behavior. A future,
- optimized implementation may occasionally wake up more than one thread.
+ The current implementation wakes up exactly *n* threads, if at least *n*
+ threads are waiting. However, it's not safe to rely on this behavior.
+ A future, optimized implementation may occasionally wake up more than
+ *n* threads.
- Note: the awakened thread does not actually return from its :meth:`wait`
+ Note: an awakened thread does not actually return from its :meth:`wait`
call until it can reacquire the lock. Since :meth:`notify` does not
release the lock, its caller should.