Skip to content
Browse files

Fix the 'run the tests' documentation

branch : fix-unittest-documentation
  • Loading branch information...
1 parent 7c80445 commit f837904e8d51e03298154128d88eb157fafedac0 @mfogel mfogel committed
Showing with 7 additions and 6 deletions.
  1. +7 −6 docs/unittests.rst
13 docs/unittests.rst
@@ -12,10 +12,11 @@ your migrations are taking way too long to apply - simply set
South's own unit tests
-South has its own set of unit tests; these will also be run when you run
-./ 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 ``./ 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 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, then running ``./ test south``.

0 comments on commit f837904

Please sign in to comment.
Something went wrong with that request. Please try again.