Add note about template debug setting to README #72
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sparrowt
reviewed
Apr 27, 2021
|
|
||
| .. 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?)
| @@ -51,6 +51,20 @@ the plugin to identify untested templates. | |||
| 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 nedbat/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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.