From: Eli Bendersky <eliben@gmail.com>
Date: Sat, 12 Nov 2011 18:44:25 +0000 (+0200)
Subject: Issue #12767: documenting threading.Condition.notify
X-Git-Tag: v3.3.0a1~857^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d44af82e62998e938dd60ff2bb70ecd6d7d52c05;p=python
Issue #12767: documenting threading.Condition.notify
---
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index 1f1d775c70..c226dd46c8 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.