From 9aba6f807ebaa4aca9885142ce2d6f5e162cb8cd Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Mon, 18 Jan 2010 23:53:08 +0000 Subject: [PATCH] Fixed #12638 -- Minor documentation cleanups around the new class-based test runners. Thanks to Ramiro Morales for the patch. git-svn-id: http://code.djangoproject.com/svn/django/trunk@12260 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/ref/settings.txt | 7 +++++-- docs/topics/testing.txt | 8 ++++---- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index daedc87d21..ca63aaf478 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1409,9 +1409,12 @@ misspelled) variables. See :ref:`invalid-template-variables`.. TEST_RUNNER ----------- -Default: ``'django.test.simple.run_tests'`` +Default: ``'django.test.simple.DjangoTestSuiteRunner'`` -The name of the method to use for starting the test suite. See +.. versionchanged:: 1.2 + Prior to 1.2, test runners were a function, not a class. + +The name of the class to use for starting the test suite. See :ref:`topics-testing`. .. _Testing Django Applications: ../testing/ diff --git a/docs/topics/testing.txt b/docs/topics/testing.txt index 18a1052483..f5098d9584 100644 --- a/docs/topics/testing.txt +++ b/docs/topics/testing.txt @@ -1247,8 +1247,8 @@ testing behavior. This behavior involves: #. Performing global post-test teardown. -If you define your own test runner method and point :setting:`TEST_RUNNER` at -that method, Django will execute your test runner whenever you run +If you define your own test runner class and point :setting:`TEST_RUNNER` at +that class, Django will execute your test runner whenever you run ``./manage.py test``. In this way, it is possible to use any test framework that can be executed from Python code, or to modify the Django test execution process to satisfy whatever testing requirements you may have. @@ -1290,7 +1290,7 @@ set up, execute and tear down the test suite. write your own test runner, ensure accept and handle the ``**kwargs`` parameter. -.. method:: DjangoTestSuiteRunner.run_tests(test_labels, extra_tests=[]) +.. method:: DjangoTestSuiteRunner.run_tests(test_labels, extra_tests=None) Run the test suite. @@ -1315,7 +1315,7 @@ set up, execute and tear down the test suite. Sets up the test environment ready for testing. -.. method:: DjangoTestSuiteRunner.build_suite(test_labels, extra_tests=[]) +.. method:: DjangoTestSuiteRunner.build_suite(test_labels, extra_tests=None) Constructs a test suite that matches the test labels provided.