Improve "Setting up URLconf" section in installation docs #1349
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
matthiask
reviewed
Sep 30, 2020
docs/installation.rst
Outdated
| @@ -43,16 +43,16 @@ If you're upgrading from a previous version, you should review the | |||
| Setting up URLconf | |||
| ------------------ | |||
|
|
|||
| Add the Debug Toolbar's URLs to your project's URLconf as follows:: | |||
| Add the Debug Toolbar's URLs to your project's URLconf as the last entry:: | |||
There was a problem hiding this comment.
Is there a reason for specifying "the last entry"?
feincms3 uses a catch-all pattern at the end (https://feincms3.readthedocs.io/en/latest/build-your-cms.html#views-and-urls), Wagtail too (https://github.com/wagtail/wagtail/blob/master/wagtail/core/urls.py)
Adding the debug toolbar after those catch-all patterns will not work.
Anyone using a CMS (feincms3 or wagtail
There was a problem hiding this comment.
Good point. It doesn't need to strictly be the last entry. I've removed that wording in the latest revision.
Remove the "if settings.DEBUG" guard. This guard is not necessary and leads to several edge cases in local development setups. This is not necessary as all views are guarded by the require_show_toolbar decorator which uses the SHOW_TOOLBAR_CALLBACK setting. This setting is already capable of enabling/disabling across the application when DEBUG is False. By default, when DEBUG is False, these views return a 404 response. By having the URLs always available, the MIDDLEWARE setting also doesn't need special handling when DEBUG is False, simplifing the overall configuration. An application should be able to reliably reverse URLs regardless of the status of DEBUG. Fixes #1035 Fixes #1043 Fixes #1332
|
Thanks! |
adamchainz
added a commit
to adamchainz/django-debug-toolbar
that referenced
this pull request
Nov 15, 2021
The import of settings is no longer required after django-commons#1349
matthiask
pushed a commit
that referenced
this pull request
Nov 15, 2021
The import of settings is no longer required after #1349
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.
Remove the "if settings.DEBUG" guard. This guard is not necessary and
leads to several edge cases in local development setups.
This is not necessary as all views are guarded by the
require_show_toolbar decorator which uses the SHOW_TOOLBAR_CALLBACK
setting. This setting is already capable of enabling/disabling the
across the application when DEBUG is False. By default, when DEBUG is
False, these views return a 404 response.
By having the URLs always available, the MIDDLEWARE setting also doesn't
need special handling when DEBUG is False, simplifing the overall
configuration. An application should be able to reliably reverse URLs
regardless of the status of DEBUG.
Fixes #1035
Fixes #1043
Fixes #1332