Django

Code

Changeset 5753

Show
Ignore:
Timestamp:
07/23/07 08:52:59 (1 year ago)
Author:
russellm
Message:

Added documentation for a test runner argument that has always been present, but was undocumented.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • django/trunk/docs/testing.txt

    r5752 r5753  
    663663---------------------- 
    664664By convention, a test runner should be called ``run_tests``; however, you 
    665 can call it anything you want. The only requirement is that it accept three 
    666 arguments: 
    667  
    668 ``run_tests(module_list, verbosity=1, interactive=True)`` 
     665can call it anything you want. The only requirement is that it has the 
     666same arguments as the Django test runner: 
     667 
     668``run_tests(module_list, verbosity=1, interactive=True, extra_tests=[])`` 
    669669    The module list is the list of Python modules that contain the models to be 
    670     tested. This is the same format returned by ``django.db.models.get_apps()`` 
     670    tested. This is the same format returned by ``django.db.models.get_apps()``. 
     671    The test runner should search these modules for tests to execute. 
    671672 
    672673    Verbosity determines the amount of notification and debug information that 
    …… 
    680681    test suite must be able to run without any manual intervention. 
    681682     
     683    ``extra_tests`` is a list of extra ``TestCase`` instances to add to the  
     684    suite that is executed by the test runner. These extra tests are run  
     685    in addition to those discovered in the modules listed in ``module_list``. 
     686     
    682687    This method should return the number of tests that failed. 
    683688