[issue17876] Doc issue with threading.Event
New submission from Xavier Ordoquy:
The documentation isn't correct for the threading.Event class under python 3.2.
In the threading doc page (http://docs.python.org/3.2/library/threading.html), Event is said to be at the same time a function and a class.
This is misleading and lead to a regression for celery under python 3.2 (https://github.com/celery/celery/pull/1333).
Could the doc be updated under python 3.2 so that threading.Event leads to the function and threading._Event leads to the class ?
Regards, Xavier.
---------- assignee: docs@python components: Documentation messages: 188127 nosy: docs@python, xordoquy priority: normal severity: normal status: open title: Doc issue with threading.Event type: enhancement versions: Python 3.2
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue17876 _______________________________________
Changes by Ezio Melotti ezio.melotti@gmail.com:
---------- keywords: +easy nosy: +ezio.melotti stage: -> needs patch
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue17876 _______________________________________
R. David Murray added the comment:
I'm sorry, the 3.2 docs are no longer updated. The effective way to become aware of these changes between versions is via the 'version changed' tags in the new documentation. You will note that these tags exist in the 3.3 docs.
---------- nosy: +r.david.murray resolution: -> out of date stage: needs patch -> committed/rejected status: open -> closed
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue17876 _______________________________________
Martijn Pieters added the comment:
I notice that the same issue still exists in the 3.5 documentation. Surely this can at least be fixed in the development copy?
---------- nosy: +mjpieters
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue17876 _______________________________________
R. David Murray added the comment:
If there really is an issue in the 3.4/3.5 docs, you should open an new issue explaining what the problem is. In 3.4/3.5, Event is a class, not a function, and is documented accordingly.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue17876 _______________________________________
Martijn Pieters added the comment:
Ah! Mea Culpa, you are correct. The issue is then with Python 2.7 only for which no doubt exists a separate ticket.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue17876 _______________________________________
participants (4)
-
Ezio Melotti -
Martijn Pieters
-
R. David Murray
-
Xavier Ordoquy