diff options
| author | Senthil Kumaran <senthil@uthcode.com> | 2011-09-06 00:23:10 +0800 |
|---|---|---|
| committer | Senthil Kumaran <senthil@uthcode.com> | 2011-09-06 00:23:10 +0800 |
| commit | 9541f8eb2b820dad3576c039ae2cba7f13ba5fc0 (patch) | |
| tree | 3607304da7f6f5f3b3a78958b800a721181b5160 | |
| parent | ab08da0a1c53c39b64d1ab36be2e067b990708ba (diff) | |
| download | cpython-git-9541f8eb2b820dad3576c039ae2cba7f13ba5fc0.tar.gz | |
merge from 3.2. Fix closes Issue11155 - Correct the multiprocessing.Queue.put's arg (replace 'item' with 'obj') in the docs. Patch by Westley MartÃnez.
| -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 45da5d390f..30c4b1031c 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]]) |