diff options
| author | Senthil Kumaran <senthil@uthcode.com> | 2011-09-05 16:21:30 (GMT) |
|---|---|---|
| committer | Senthil Kumaran <senthil@uthcode.com> | 2011-09-05 16:21:30 (GMT) |
| commit | e969a2117c6fdbe794fad9292823a2d7edc7a6d0 (patch) | |
| tree | 0e427c5ef864d291bce5a63a6b66860ee303968e /Doc/library/multiprocessing.rst | |
| parent | bcf99ac6650e69aac23af439cf23a8129ae2fba8 (diff) | |
| download | cpython-e969a2117c6fdbe794fad9292823a2d7edc7a6d0.zip cpython-e969a2117c6fdbe794fad9292823a2d7edc7a6d0.tar.gz cpython-e969a2117c6fdbe794fad9292823a2d7edc7a6d0.tar.bz2 | |
Fix closes Issue11155 - Correct the multiprocessing.Queue.put's arg (replace 'item' with 'obj') in the docs. Patch by Westley MartÃnez.
Diffstat (limited to 'Doc/library/multiprocessing.rst')
| -rw-r--r-- | Doc/library/multiprocessing.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index d95b33c..78e3e95 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]]) |