From: Berker Peksag <berker.peksag@gmail.com>
Date: Mon, 2 May 2016 09:25:35 +0000 (+0300)
Subject: Issue #18916: Update thread module docstrings
X-Git-Tag: v3.6.0a1~85^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=720e65541cc288f4015021ffeb4c03b1f0937895;p=thirdparty%2FPython%2Fcpython.git

Issue #18916: Update thread module docstrings

* Fix acquire() signature
* Remove outdated help(LockType) reference
* Replace PyThread_allocate_lock() with threading.Lock()

Patch by Christopher Welborn.
---

diff --git a/Modules/_threadmodule.c b/Modules/_threadmodule.c
index bcb3aeeb22a0..968181cd8a8c 100644
--- a/Modules/_threadmodule.c
+++ b/Modules/_threadmodule.c
@@ -159,7 +159,7 @@ lock_PyThread_acquire_lock(lockobject *self, PyObject *args, PyObject *kwds)
 }
 
 PyDoc_STRVAR(acquire_doc,
-"acquire([wait]) -> bool\n\
+"acquire(blocking=True, timeout=-1) -> bool\n\
 (acquire_lock() is an obsolete synonym)\n\
 \n\
 Lock the lock.  Without argument, this blocks if the lock is already\n\
@@ -1134,7 +1134,8 @@ PyDoc_STRVAR(allocate_doc,
 "allocate_lock() -> lock object\n\
 (allocate() is an obsolete synonym)\n\
 \n\
-Create a new lock object.  See help(LockType) for information about locks.");
+Create a new lock object. See help(type(threading.Lock())) for\n\
+information about locks.");
 
 static PyObject *
 thread_get_ident(PyObject *self)
@@ -1326,7 +1327,7 @@ The 'threading' module provides a more convenient interface.");
 
 PyDoc_STRVAR(lock_doc,
 "A lock object is a synchronization primitive.  To create a lock,\n\
-call the PyThread_allocate_lock() function.  Methods are:\n\
+call threading.Lock().  Methods are:\n\
 \n\
 acquire() -- lock the lock, possibly blocking until it can be obtained\n\
 release() -- unlock of the lock\n\