Add docs for CaptureFixture

pytest-dev · Mar 6, 2018 · 18a47bf · 18a47bf
1 parent 3979f9b
commit 18a47bf
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/_pytest/capture.py b/_pytest/capture.py
@@ -292,10 +292,9 @@ def close(self):
             cap.stop_capturing()
 
     def readouterr(self):
-        """Read and return the captured output so far.
+        """Read and return the captured output so far, resetting the internal buffer.
 
-        :rtype: Tuple[str, str]
-        :return: captured content as a pair of (stdout, stdout) strings
+        :return: captured content as a namedtuple with  ``out`` and ``err`` string attributes
         """
         try:
             return self._capture.readouterr()

diff --git a/doc/en/reference.rst b/doc/en/reference.rst
@@ -264,6 +264,9 @@ capsys
             captured = capsys.readouterr()
             assert captured.out == "hello\n"
 
+.. autoclass:: CaptureFixture()
+    :members:
+
 
 capsysbinary
 ~~~~~~~~~~~~