From f099ef3ef53f88160d04d7dcc73859801b05a83e Mon Sep 17 00:00:00 2001
From: Mariusz Felisiak <felisiak.mariusz@gmail.com>
Date: Thu, 18 Mar 2021 11:41:24 +0100
Subject: [PATCH] Added parallel argument to DiscoverRunner docs.
Follow up to cd9fcd4e8073490a52c9e79133ada4661cb7db38.
---
docs/topics/testing/advanced.txt | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/docs/topics/testing/advanced.txt b/docs/topics/testing/advanced.txt
index 8b636ae2e3..e7fdf89ff8 100644
--- a/docs/topics/testing/advanced.txt
+++ b/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 by ``run_tests()`` to set up, 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, buffer=False, enable_faulthandler=True, timing=True, **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, parallel=0, test_name_patterns=None, pdb=False, buffer=False, enable_faulthandler=True, timing=True, **kwargs)
``DiscoverRunner`` will search for tests in any file matching ``pattern``.
@@ -544,6 +544,12 @@ and tear down the test suite.
``debug_mode`` specifies what the :setting:`DEBUG` setting should be
set to prior to running tests.
+ ``parallel`` specifies the number of processes. If ``parallel`` is greater
+ than ``1``, the test suite will run in ``parallel`` processes. If there are
+ fewer test cases than configured processes, Django will reduce the number
+ of processes accordingly. Each process gets its own database. This option
+ requires the third-party ``tblib`` package to display tracebacks correctly.
+
If ``debug_sql`` is ``True``, failing test cases will output SQL queries
logged to the :ref:`django.db.backends logger <django-db-logger>` as well
as the traceback. If ``verbosity`` is ``2``, then queries in all tests are