Skip to content

Commit 875d581

Browse files
authored
Make doc corrections for django channels (#2232)
1 parent 62ef502 commit 875d581

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

docs/architecture.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,5 @@ Problematic Parts
8585
fully compatible and currently being worked on. For now, these panels
8686
are disabled by default when running in async environment.
8787
follow the progress of this issue in `Async compatible toolbar project <https://github.com/orgs/jazzband/projects/9>`_.
88+
- Django Channels incompatibility: The toolbar does not currently support
89+
Django Channels' consumers due to the difference in middleware design.

docs/changes.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Pending
1919
* Updated logic that forces values to strings (``force_str``) to render
2020
"Django Debug Toolbar was unable to parse value." when there's a decoding
2121
error.
22+
* Updated docs to show incompatibility with Django Channels.
2223

2324
6.0.0 (2025-07-22)
2425
------------------

docs/installation.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,12 +273,13 @@ And for Apache:
273273
Django Channels & Async
274274
^^^^^^^^^^^^^^^^^^^^^^^
275275

276-
The Debug Toolbar currently has experimental support for Django Channels and
277-
async projects. The Debug Toolbar is compatible with the following exceptions:
276+
The Debug Toolbar currently has experimental support for async projects.
277+
The Debug Toolbar is compatible with the following exceptions:
278278

279279
- Concurrent requests aren't supported
280280
- ``TimerPanel``, ``RequestPanel`` and ``ProfilingPanel`` can't be used
281281
in async contexts.
282+
- Django Channels is not supported yet.
282283

283284
HTMX
284285
^^^^

0 commit comments

Comments
 (0)