[issue12767] document threading.Condition.notify

Roundup Robot added the comment: New changeset 63a00d019bb2 by Eli Bendersky in branch '2.7': Closes issue 12767: document the argument of threading.Condition.notify http://hg.python.org/cpython/rev/63a00d019bb2 -- resolution: -> fixed stage: patch review -> committed/rejected status:

[issue12767] document threading.Condition.notify

Roundup Robot added the comment: New changeset 63a24bff6f36 by Eli Bendersky in branch '3.2': Issue #12767: documenting threading.Condition.notify http://hg.python.org/cpython/rev/63a24bff6f36 New changeset ac12dcea69e1 by Eli Bendersky in branch 'default': Issue 12767: document the argument of

[issue12767] document threading.Condition.notify

Eli Bendersky added the comment: Ezio, thanks for the catch. I missed that one. Attaching a new, fixed patch. -- Added file: http://bugs.python.org/file23658/issue12767.2.patch ___ Python tracker _

[issue12767] document threading.Condition.notify

Ezio Melotti added the comment: + This method wakes up at most *n* of the threads + The current implementation wakes up exactly *n* threads + A future, optimized implementation may occasionally wake up more than + one thread. Isn't this a bit contradictory? -- nosy:

[issue12767] document threading.Condition.notify

Eli Bendersky added the comment: I propose the attached patch for the documentation. Any objections? -- keywords: +patch Added file: http://bugs.python.org/file23657/issue12767.1.patch ___ Python tracker _

[issue12767] document threading.Condition.notify

Graeme Cross added the comment: I have added documentation for the 'n' parameter of threading.Condition.notify as part of the overhaul of the threading module's docstrings. Reference: #12768 -- nosy: +gjcross ___ Python tracker

[issue12767] document threading.Condition.notify

Antoine Pitrou added the comment: > I asked the user who reported this documentation omission what he's > using the 'n' argument for. His reply: > > "Yes I am using the n parameter, it is mainly to implement a > subclass of Queue that supports "bulk" get and put operations. This > enhances

[issue12767] document threading.Condition.notify

Eli Bendersky added the comment: I asked the user who reported this documentation omission what he's using the 'n' argument for. His reply: "Yes I am using the n parameter, it is mainly to implement a subclass of Queue that supports "bulk" get and put operations. This enhances the perfor

[issue12767] document threading.Condition.notify

R. David Murray added the comment: Good point. Probably, then, we should just put a comment in the code that 'n' is an internal implementation detail and leave it at that. -- ___ Python tracker _

[issue12767] document threading.Condition.notify

Eli Bendersky added the comment: David, while you make a valid point, consider that 'n' is part of the public API of the threading module (although not documented) and it's conceivable that there is existing code "in the wild" using it. To do what you suggest we should maybe go through a norm

[issue12767] document threading.Condition.notify

R. David Murray added the comment: >From a quick look at the code and docs I suspect that 'n' is an internal >implementation detail and not meant to be exposed. Is there an use case for >notifying waiters where n!=1 and n!=len(waiters)? If my speculation is >correct it might be a good idea

[issue12767] document threading.Condition.notify

Eli Bendersky added the comment: Opened Issue 12768 on the general lack of docstrings in the threading module -- ___ Python tracker ___ _

[issue12767] document threading.Condition.notify

New submission from Eli Bendersky : User report (Jiachang Xu) from the docs mailing list: The theading.Condition.notify method has a parameter - n, which isn't documented in the the documentation of the threading module. 1. The parameter should be documented 2. notify() is mentioned multiple t