Add note about template debug setting to README #72
Conversation
sparrowt
left a comment
sparrowt
left a comment
There was a problem hiding this comment.
Noting this in the readme would have saved me a lot of time 👍 A couple of thoughts
|
|
||
| .. code-block:: python | ||
| DEBUG = True |
There was a problem hiding this comment.
In my local testing this top-level Django DEBUG setting isn't required, only the template debug setting below is needed so TEMPLATES ... 'OPTIONS': { 'debug': True } does seem to work even with DEBUG=False.
Given it is preferable to run tests in an as-close-to-prod-as-possible configuration, perhaps remove this line & set 'debug': True, below? (or 'debug': VAR_WHICH_IS_TRUE_IN_TESTING_ONLY to avoid enabling debug templates in prod?)
| If you get a :code:`django.core.exceptions.ImproperlyConfigured` error, | ||
| you need to set the :code:`DJANGO_SETTINGS_MODULE` environment variable. | ||
|
|
||
| If you get :code:`django_coverage_plugin.plugin.DjangoTemplatePluginException: Template debugging must be enabled in settings`, change your TEMPLATES setting: |
There was a problem hiding this comment.
As of coveragepy/coveragepy@30c023b, the check is now a real Python warning, so pytest will display it.
|
@nedbat wonder if this can be merged? Thanks! |
|
Thanks, I'll merge this and then make some tweaks. |
4 participants
No description provided.