Commits

Mike Fogel committed 3f4bcfb

Fix the 'run the tests' documentation

Comments (0)

Files changed (1)

docs/unittests.rst

 South's own unit tests
 ----------------------
 
-South has its own set of unit tests; these will also be run when you run
-./manage.py test. They do some fiddling with Django internals to set up a
-proper test environment; it's non-destructive, but if it's fouling up your own
-tests please submit a ticket about it.
+South has its own set of unit tests, however, these will not be run by default
+when you run ``./manage.py test``. This is mainly because the test suite is
+meant to be run in isolation (the test framework continually changes
+``INSTALLED_APPS`` and fiddles with the ORM as it runs, among other things),
+and can cause compatability problems with other applications.
 
-You can also set ``SKIP_SOUTH_TESTS=True`` in settings.py to stop South's tests
-running, should they be causing issues.
+You can run South's test suite by setting ``SKIP_SOUTH_TESTS = False``
+in settings.py, then running ``./manage.py test south``.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.