[issue17091] thread.lock.acquire docstring bug

[R. David Murray]

R. David Murray added the comment:

Thanks, Ian.

--
resolution:  -> fixed
stage:  -> committed/rejected
status: open -> closed
versions: +Python 3.2

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17091] thread.lock.acquire docstring bug

[Roundup Robot]

Roundup Robot added the comment:

New changeset 0cc51c04aa20 by R David Murray in branch '3.2':
#17091: update docstring for _thread.Lock.acquire.
http://hg.python.org/cpython/rev/0cc51c04aa20

New changeset b414b2dfd3d3 by R David Murray in branch '3.3':
merge #17091: update docstring for _thread.Lock.acquire.
http://hg.python.org/cpython/rev/b414b2dfd3d3

New changeset a80abb179ba1 by R David Murray in branch 'default':
merge #17091: update docstring for _thread.Lock.acquire.
http://hg.python.org/cpython/rev/a80abb179ba1

New changeset 20f0c5398e97 by R David Murray in branch '2.7':
#17091: update docstring for _thread.Lock.acquire.
http://hg.python.org/cpython/rev/20f0c5398e97

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17091] thread.lock.acquire docstring bug

[Ian Cordasco]

Ian Cordasco added the comment:

Thanks. I couldn't find it in the source but I just found 
Modules/_threadmodule.c

I tested the method from the interpreter to confirm the changes I was making to 
the docstring. Attached is a diff that covers the change.

--
Added file: http://bugs.python.org/file28949/doc_fix.txt

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17091] thread.lock.acquire docstring bug

[R. David Murray]

Changes by R. David Murray :


--
versions: +Python 3.3, Python 3.4 -Python 3.5

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17091] thread.lock.acquire docstring bug

[R. David Murray]

R. David Murray added the comment:

Armin is talking about the docstring, not the docs.  That is, what you get if 
you do help(x.acquire), where x is a Lock object, at the Python prompt.

--
nosy: +r.david.murray

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17091] thread.lock.acquire docstring bug

[Ian Cordasco]

Ian Cordasco added the comment:

Was this already taken care of? 
http://docs.python.org/2/library/thread.html?highlight=thread.lock#thread.lock.acquire
 and 
http://docs.python.org/3.3/library/_thread.html?highlight=thread.lock#_thread.lock.acquire
 don't make any mention of returning None.

--
nosy: +icordasc

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17091] thread.lock.acquire docstring bug

[Armin Rigo]

New submission from Armin Rigo:

The docstring of thread.lock.acquire() (or _thread on Python 3) is bogus: it 
says that if called without argument, the return value is None; it is only if 
called with a "blocking" argument that it returns True or False.  But since a 
long time it was always returning a boolean, never None.

--
assignee: docs@python
components: Documentation
keywords: easy
messages: 181035
nosy: arigo, docs@python
priority: normal
severity: normal
status: open
title: thread.lock.acquire docstring bug
versions: Python 2.7, Python 3.5

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com