Browse Source

Refs #27430 -- Added buffer argument to DiscoverRunner docs.

Mariusz Felisiak 4 years ago
parent
commit
188f7786bc
1 changed files with 7 additions and 1 deletions
  1. 7 1
      docs/topics/testing/advanced.txt

+ 7 - 1
docs/topics/testing/advanced.txt

@@ -510,7 +510,7 @@ behavior. This class defines the ``run_tests()`` entry point, plus a
 selection of other methods that are used to by ``run_tests()`` to set up,
 selection of other methods that are used to by ``run_tests()`` to set up,
 execute and tear down the test suite.
 execute and tear down the test suite.
 
 
-.. class:: DiscoverRunner(pattern='test*.py', top_level=None, verbosity=1, interactive=True, failfast=False, keepdb=False, reverse=False, debug_mode=False, debug_sql=False, test_name_patterns=None, pdb=False, **kwargs)
+.. class:: DiscoverRunner(pattern='test*.py', top_level=None, verbosity=1, interactive=True, failfast=False, keepdb=False, reverse=False, debug_mode=False, debug_sql=False, test_name_patterns=None, pdb=False, buffer=False, **kwargs)
 
 
     ``DiscoverRunner`` will search for tests in any file matching ``pattern``.
     ``DiscoverRunner`` will search for tests in any file matching ``pattern``.
 
 
@@ -555,6 +555,8 @@ execute and tear down the test suite.
     If ``pdb`` is ``True``, a debugger (``pdb`` or ``ipdb``) will be spawned at
     If ``pdb`` is ``True``, a debugger (``pdb`` or ``ipdb``) will be spawned at
     each test error or failure.
     each test error or failure.
 
 
+    If ``buffer`` is ``True``, outputs from passing tests will be discarded.
+
     Django may, from time to time, extend the capabilities of the test runner
     Django may, from time to time, extend the capabilities of the test runner
     by adding new arguments. The ``**kwargs`` declaration allows for this
     by adding new arguments. The ``**kwargs`` declaration allows for this
     expansion. If you subclass ``DiscoverRunner`` or write your own test
     expansion. If you subclass ``DiscoverRunner`` or write your own test
@@ -565,6 +567,10 @@ execute and tear down the test suite.
     custom arguments by calling ``parser.add_argument()`` inside the method, so
     custom arguments by calling ``parser.add_argument()`` inside the method, so
     that the :djadmin:`test` command will be able to use those arguments.
     that the :djadmin:`test` command will be able to use those arguments.
 
 
+    .. versionadded:: 3.1
+
+        The ``buffer`` argument was added.
+
 Attributes
 Attributes
 ~~~~~~~~~~
 ~~~~~~~~~~