From: Senthil Kumaran Date: Mon, 5 Sep 2011 16:21:30 +0000 (+0800) Subject: Fix closes Issue11155 - Correct the multiprocessing.Queue.put's arg (replace 'item... X-Git-Tag: v3.3.0a1~1570^2~7^2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e969a2117c6fdbe794fad9292823a2d7edc7a6d0;p=python Fix closes Issue11155 - Correct the multiprocessing.Queue.put's arg (replace 'item' with 'obj') in the docs. Patch by Westley Martínez. --- diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index d95b33c42f..78e3e951b4 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -552,9 +552,9 @@ For an example of the usage of queues for interprocess communication see Return ``True`` if the queue is full, ``False`` otherwise. Because of multithreading/multiprocessing semantics, this is not reliable. - .. method:: put(item[, block[, timeout]]) + .. method:: put(obj[, block[, timeout]]) - Put item into the queue. If the optional argument *block* is ``True`` + Put obj into the queue. If the optional argument *block* is ``True`` (the default) and *timeout* is ``None`` (the default), block if necessary until a free slot is available. If *timeout* is a positive number, it blocks at most *timeout* seconds and raises the :exc:`queue.Full` exception if no @@ -563,9 +563,9 @@ For an example of the usage of queues for interprocess communication see available, else raise the :exc:`queue.Full` exception (*timeout* is ignored in that case). - .. method:: put_nowait(item) + .. method:: put_nowait(obj) - Equivalent to ``put(item, False)``. + Equivalent to ``put(obj, False)``. .. method:: get([block[, timeout]])