[Python-checkins] cpython (2.7): #7960: fix docstrings for captured_output and captured_stdout.

[ezio.melotti]

http://hg.python.org/cpython/rev/459e2c024420
changeset:   70088:459e2c024420
branch:      2.7
parent:      70084:5b0fecd2eba0
user:        Ezio Melotti <ezio.melotti at gmail.com>
date:        Sat May 14 08:19:43 2011 +0300
summary:
  #7960: fix docstrings for captured_output and captured_stdout.

files:
  Lib/test/test_support.py |  16 ++++++++--------
  1 files changed, 8 insertions(+), 8 deletions(-)


diff --git a/Lib/test/test_support.py b/Lib/test/test_support.py
--- a/Lib/test/test_support.py
+++ b/Lib/test/test_support.py
@@ -814,14 +814,8 @@
 
 @contextlib.contextmanager
 def captured_output(stream_name):
-    """Run the 'with' statement body using a StringIO object in place of a
-    specific attribute on the sys module.
-    Example use (with 'stream_name=stdout')::
-
-       with captured_stdout() as s:
-           print "hello"
-       assert s.getvalue() == "hello"
-    """
+    """Return a context manager used by captured_stdout and captured_stdin
+    that temporarily replaces the sys stream *stream_name* with a StringIO."""
     import StringIO
     orig_stdout = getattr(sys, stream_name)
     setattr(sys, stream_name, StringIO.StringIO())
@@ -831,6 +825,12 @@
         setattr(sys, stream_name, orig_stdout)
 
 def captured_stdout():
+    """Capture the output of sys.stdout:
+
+       with captured_stdout() as s:
+           print "hello"
+       self.assertEqual(s.getvalue(), "hello")
+    """
     return captured_output("stdout")
 
 def captured_stdin():

-- 
Repository URL: http://hg.python.org/cpython