summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-02-04 15:29:38 (GMT)
committerR David Murray <rdmurray@bitdance.com>2013-02-04 15:29:38 (GMT)
commit381372d1be8e511f0e5d2940c478f53ca38f535f (patch)
tree4f83eafd680fd6b2a30cc829f29832fce31f0ec9
parent28ababcda4738165f96c95188f3cbeb9784ce074 (diff)
downloadcpython-381372d1be8e511f0e5d2940c478f53ca38f535f.zip
cpython-381372d1be8e511f0e5d2940c478f53ca38f535f.tar.gz
cpython-381372d1be8e511f0e5d2940c478f53ca38f535f.tar.bz2
#17091: update docstring for _thread.Lock.acquire.
The main docs were fixed to remove mention of None long ago, but the docstring was not. Reported by Armin Rigo, patch by Ian Cordasco.
-rw-r--r--Modules/threadmodule.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/Modules/threadmodule.c b/Modules/threadmodule.c
index 9462f43..efc5d7f 100644
--- a/Modules/threadmodule.c
+++ b/Modules/threadmodule.c
@@ -56,12 +56,12 @@ lock_PyThread_acquire_lock(lockobject *self, PyObject *args)
}
PyDoc_STRVAR(acquire_doc,
-"acquire([wait]) -> None or bool\n\
+"acquire([wait]) -> bool\n\
(acquire_lock() is an obsolete synonym)\n\
\n\
Lock the lock. Without argument, this blocks if the lock is already\n\
locked (even by the same thread), waiting for another thread to release\n\
-the lock, and return None once the lock is acquired.\n\
+the lock, and return True once the lock is acquired.\n\
With an argument, this will only block if the argument is true,\n\
and the return value reflects whether the lock is acquired.\n\
The blocking operation is not interruptible.");