make doc corrections for django channels #2232
Merged
+6
−2
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
docs/installation.rst
Outdated
Comment on lines
276
to
278
| The Debug Toolbar currently has experimental support for async projects, | ||
| but not for Django Channels. The Debug Toolbar is compatible with the | ||
| following exceptions: |
There was a problem hiding this comment.
This reads a bit weird with two blocks of exceptions. Maybe we just move the channels incompatibility down into the list of exceptions so it's just one list of ways the toolbar doesn't work with async projects?
docs/architecture.rst
Outdated
| are disabled by default when running in async environment. | ||
| follow the progress of this issue in `Async compatible toolbar project <https://github.com/orgs/jazzband/projects/9>`_. | ||
| - Django Channels incompatibility: The toolbar does not currently support | ||
| Django Channels' consumers. |
There was a problem hiding this comment.
Suggested change
| Django Channels' consumers. | |
| Django Channels' consumers due to the difference in middleware design. |
The little contextual note may be helpful for a future reader if they don't realize to check the issues first.
tim-schilling
requested changes
Oct 21, 2025
|
How's it looking now? @tim-schilling |
tim-schilling
approved these changes
Oct 24, 2025
|
Thank you @Chiemezuo! |
|
Thanks for the merge! @tim-schilling |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Following up on PR #2228 , the documentation needed some correction to state that the Toolbar currently doesn't support Django Channels.
Fixes #2231
Checklist:
docs/changes.rst.