gh-135730: Clarify multiprocessing.Queue close() documentation (GH-136803)
Add a copy of the text from SimpleQueue.close()
---------
(cherry picked from commit
f575588ccf27d8d54a1e99cfda944f2614b3255c)
Co-authored-by: aggshruti99 <aggshruti99@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
.. method:: close()
- Indicate that no more data will be put on this queue by the current
- process. The background thread will quit once it has flushed all buffered
+ Close the queue: release internal resources.
+
+ A queue must not be used anymore after it is closed. For example,
+ :meth:`~Queue.get`, :meth:`~Queue.put` and :meth:`~Queue.empty`
+ methods must no longer be called.
+
+ The background thread will quit once it has flushed all buffered
data to the pipe. This is called automatically when the queue is garbage
collected.