Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed #20177 - Corrected docs for django.test.utils.setup_test_enviro…

…nment.

Thanks vlad.london.uk@ for the report.
  • Loading branch information...
commit bc02a963db3aeebf7c349d83a492b6e093f42b00 1 parent e886808
Tim Graham authored May 06, 2013
7  docs/intro/tutorial05.txt
@@ -326,6 +326,13 @@ in the shell::
326 326
     >>> from django.test.utils import setup_test_environment
327 327
     >>> setup_test_environment()
328 328
 
  329
+:meth:`~django.test.utils.setup_test_environment` installs a template renderer
  330
+which will allow us to examine some additional attributes on responses such as
  331
+``response.context`` that otherwise wouldn't be available. Note that this
  332
+method *does not* setup a test database, so the following will be run against
  333
+the existing database and the output may differ slightly depending on what
  334
+polls you already created.
  335
+
329 336
 Next we need to import the test client class (later in ``tests.py`` we will use
330 337
 the :class:`django.test.TestCase` class, which comes with its own client, so
331 338
 this won't be required)::
12  docs/topics/testing/advanced.txt
@@ -163,10 +163,12 @@ environment first. Django provides a convenience method to do this::
163 163
     >>> from django.test.utils import setup_test_environment
164 164
     >>> setup_test_environment()
165 165
 
166  
-This convenience method sets up the test database, and puts other
167  
-Django features into modes that allow for repeatable testing.
  166
+:func:`~django.test.utils.setup_test_environment` puts several Django features
  167
+into modes that allow for repeatable testing, but does not create the test
  168
+databases; :func:`django.test.simple.DjangoTestSuiteRunner.setup_databases`
  169
+takes care of that.
168 170
 
169  
-The call to :meth:`~django.test.utils.setup_test_environment` is made
  171
+The call to :func:`~django.test.utils.setup_test_environment` is made
170 172
 automatically as part of the setup of ``./manage.py test``. You only
171 173
 need to manually invoke this method if you're not using running your
172 174
 tests via Django's test runner.
@@ -282,7 +284,9 @@ Methods
282 284
 
283 285
 .. method:: DjangoTestSuiteRunner.setup_test_environment(**kwargs)
284 286
 
285  
-    Sets up the test environment ready for testing.
  287
+    Sets up the test environment by calling
  288
+    :func:`~django.test.utils.setup_test_environment` and setting
  289
+    :setting:`DEBUG` to ``False``.
286 290
 
287 291
 .. method:: DjangoTestSuiteRunner.build_suite(test_labels, extra_tests=None, **kwargs)
288 292
 

0 notes on commit bc02a96

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