Browse Source

Edited docs of test.utils.setup/teardown_test_environment().

Chris Jerdonek 8 years ago
parent
commit
42f9d65107
2 changed files with 10 additions and 15 deletions
  1. 6 9
      django/test/utils.py
  2. 4 6
      docs/topics/testing/advanced.txt

+ 6 - 9
django/test/utils.py

@@ -95,11 +95,9 @@ def instrumented_test_render(self, context):
 
 
 def setup_test_environment():
-    """Perform any global pre-test setup. This involves:
-
-        - Installing the instrumented test renderer
-        - Set the email backend to the locmem email backend.
-        - Setting the active locale to match the LANGUAGE_CODE setting.
+    """
+    Perform global pre-test setup, such as installing the instrumented template
+    renderer and setting the email backend to the locmem email backend.
     """
     Template._original_render = Template._render
     Template._render = instrumented_test_render
@@ -120,10 +118,9 @@ def setup_test_environment():
 
 
 def teardown_test_environment():
-    """Perform any global post-test teardown. This involves:
-
-        - Restoring the original test renderer
-        - Restoring the email sending functions
+    """
+    Perform any global post-test teardown, such as restoring the original
+    template renderer and restoring the email sending functions.
     """
     Template._render = Template._original_render
     del Template._original_render

+ 4 - 6
docs/topics/testing/advanced.txt

@@ -607,15 +607,13 @@ utility methods in the ``django.test.utils`` module.
 
 .. function:: setup_test_environment()
 
-    Performs any global pre-test setup, such as the installing the
-    instrumentation of the template rendering system and setting up
-    the dummy email outbox.
+    Performs global pre-test setup, such as installing instrumentation for the
+    template rendering system and setting up the dummy email outbox.
 
 .. function:: teardown_test_environment()
 
-    Performs any global post-test teardown, such as removing the black
-    magic hooks into the template system and restoring normal email
-    services.
+    Performs global post-test teardown, such as removing instrumentation from
+    the template system and restoring normal email services.
 
 ``django.db.connection.creation``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~