summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew M. Kuchling <amk@amk.ca>2005-06-02 16:59:18 (GMT)
committerAndrew M. Kuchling <amk@amk.ca>2005-06-02 16:59:18 (GMT)
commit921879abc2bd233d4ce337b3976ff81c7bd017b3 (patch)
treeec9c1d7aee76e6b7759384230dcac15fe785bdc1
parent6a15c5d038704eac43e9bdde10be26ee97a43a76 (diff)
downloadcpython-921879abc2bd233d4ce337b3976ff81c7bd017b3.zip
cpython-921879abc2bd233d4ce337b3976ff81c7bd017b3.tar.gz
cpython-921879abc2bd233d4ce337b3976ff81c7bd017b3.tar.bz2
[Bug #1209880] Describe only the True/False return values from lock.acquire()
-rw-r--r--Doc/lib/libthread.tex4
-rw-r--r--Doc/lib/libthreading.tex3
2 files changed, 3 insertions, 4 deletions
diff --git a/Doc/lib/libthread.tex b/Doc/lib/libthread.tex
index 052867f..4914948d 100644
--- a/Doc/lib/libthread.tex
+++ b/Doc/lib/libthread.tex
@@ -81,11 +81,11 @@ Lock objects have the following methods:
Without the optional argument, this method acquires the lock
unconditionally, if necessary waiting until it is released by another
thread (only one thread at a time can acquire a lock --- that's their
-reason for existence), and returns \code{None}. If the integer
+reason for existence). If the integer
\var{waitflag} argument is present, the action depends on its
value: if it is zero, the lock is only acquired if it can be acquired
immediately without waiting, while if it is nonzero, the lock is
-acquired unconditionally as before. If an argument is present, the
+acquired unconditionally as before. The
return value is \code{True} if the lock is acquired successfully,
\code{False} if not.
\end{methoddesc}
diff --git a/Doc/lib/libthreading.tex b/Doc/lib/libthreading.tex
index 5b50a22..3526974 100644
--- a/Doc/lib/libthreading.tex
+++ b/Doc/lib/libthreading.tex
@@ -167,8 +167,7 @@ All methods are executed atomically.
Acquire a lock, blocking or non-blocking.
When invoked without arguments, block until the lock is
-unlocked, then set it to locked, and return. There is no
-return value in this case.
+unlocked, then set it to locked, and return true.
When invoked with the \var{blocking} argument set to true, do the
same thing as when called without arguments, and return true.