From 93d25b8a11b776d2695ab04b1824ff26541b8a53 Mon Sep 17 00:00:00 2001 From: Chiemezuo Date: Mon, 20 Oct 2025 22:30:00 +0100 Subject: [PATCH 1/2] make doc corrections for django channels --- docs/architecture.rst | 2 ++ docs/installation.rst | 5 +++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/architecture.rst b/docs/architecture.rst index f3bae60df..75e439294 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -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 `_. +- Django Channels incompatibility: The toolbar does not currently support + Django Channels' consumers. diff --git a/docs/installation.rst b/docs/installation.rst index 995214766..4c478aa79 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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: - Concurrent requests aren't supported - ``TimerPanel``, ``RequestPanel`` and ``ProfilingPanel`` can't be used From 61584aed3a7cce0a222c82843bb44936bea981fe Mon Sep 17 00:00:00 2001 From: Chiemezuo Date: Wed, 22 Oct 2025 16:23:08 +0100 Subject: [PATCH 2/2] Reword docs on Django Channels --- docs/architecture.rst | 2 +- docs/changes.rst | 1 + docs/installation.rst | 6 +++--- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/architecture.rst b/docs/architecture.rst index 75e439294..e93196f34 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -86,4 +86,4 @@ Problematic Parts are disabled by default when running in async environment. follow the progress of this issue in `Async compatible toolbar project `_. - Django Channels incompatibility: The toolbar does not currently support - Django Channels' consumers. + Django Channels' consumers due to the difference in middleware design. diff --git a/docs/changes.rst b/docs/changes.rst index 452242279..25ee5d066 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -13,6 +13,7 @@ Pending class instance, regardless if any data was generated. * Fixed selenium tests for CI by using psycopg for Python 3.13 runs. * Added ``CommunityPanel`` containing links to documentation and resources. +* Updated docs to show incompatibility with Django Channels. 6.0.0 (2025-07-22) ------------------ diff --git a/docs/installation.rst b/docs/installation.rst index 4c478aa79..80765b102 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -273,13 +273,13 @@ And for Apache: Django Channels & Async ^^^^^^^^^^^^^^^^^^^^^^^ -The Debug Toolbar currently has experimental support for async projects, -but not for Django Channels. The Debug Toolbar is compatible with the -following exceptions: +The Debug Toolbar currently has experimental support for async projects. +The Debug Toolbar is compatible with the following exceptions: - Concurrent requests aren't supported - ``TimerPanel``, ``RequestPanel`` and ``ProfilingPanel`` can't be used in async contexts. +- Django Channels is not supported yet. HTMX ^^^^