Skip to content

make doc corrections for django channels #2232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 24, 2025
Merged

make doc corrections for django channels #2232

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93d25b8
make doc corrections for django channels
Chiemezuo Oct 20, 2025
61584ae
Reword docs on Django Channels
Chiemezuo Oct 22, 2025
19d123a
Merge branch 'main' into doc/django-channels-not-supported
Chiemezuo Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/architecture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,5 @@ Problematic Parts
fully compatible and currently being worked on. For now, these panels
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.
Copy link
Member

@tim-schilling tim-schilling Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

5 changes: 3 additions & 2 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,8 +273,9 @@ And for Apache:
Django Channels & Async
^^^^^^^^^^^^^^^^^^^^^^^

The Debug Toolbar currently has experimental support for Django Channels and
async projects. The Debug Toolbar is compatible with the following exceptions:
The Debug Toolbar currently has experimental support for async projects,
but not for Django Channels. The Debug Toolbar is compatible with the
following exceptions:
Copy link
Member

@tim-schilling tim-schilling Oct 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?


- Concurrent requests aren't supported
- ``TimerPanel``, ``RequestPanel`` and ``ProfilingPanel`` can't be used
Expand Down