Commits

Vinay Sajip committed a629f8a Draft

Routine update.

Comments (0)

Files changed (1)

docs/reference.rst

                 within the specified timeout, or ``None`` if no match was
                 found.
 
+   .. method:: close(stop_threads=False):
+
+      Close the capture object. By default, this waits for the threads which
+      read the captured streams to terminate (which may not happen unless the
+      child process is killed, and the streams read to exhaustion). To ensure
+      that the threads are stopped immediately, specify ``True` for the
+      ``stop_threads`` parameter, which will asks the threads to terminate
+      immediately, potentially losing output from the captured streams which
+      has not yet been read.
+
 
 .. class:: Popen