From: Gregory P. Smith <greg@mad-scientist.com>
Date: Mon, 4 Aug 2008 18:34:07 +0000 (+0000)
Subject: more cleanup ups of the recently added warnings in the subprocess docs.
X-Git-Tag: v2.6b3~141
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=33ede08cdd44f1f98369f969c5533129f890c4f3;p=python

more cleanup ups of the recently added warnings in the subprocess docs.
---

diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 32a1d667c2..67ebd8e3df 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -196,8 +196,8 @@ Instances of the :class:`Popen` class have the following methods:
    .. warning::
 
       This will deadlock if the child process generates enough output to a
-      stdout or stderr pipe causing it to block waiting for the OS's pipe buffer
-      to accept more data.
+      stdout or stderr pipe such that it blocks waiting for the OS pipe buffer
+      to accept more data.  Use :meth:`communicate` to avoid that.
 
 
 .. method:: Popen.communicate(input=None)
@@ -253,9 +253,10 @@ The following attributes are also available:
 
 .. warning::
 
-   Use :meth:`communicate` rather than ``.stdin.write()``, ``.stdout.read()`` or
-   ``.stderr.read`` to avoid deadlocks due to any of the other pipe buffers
-   filling up and blocking the child process.
+   Use :meth:`communicate` rather than :meth:`.stdin.write`,
+   :meth:`.stdout.read` or :meth:`.stderr.read` to avoid deadlocks due
+   to any of the other OS pipe buffers filling up and blocking the child
+   process.
 
 
 .. attribute:: Popen.stdin