Skip to content

Commit cda70d3

Browse files
committed
Documented experimental async support.
1 parent 5086e68 commit cda70d3

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

README.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,10 @@ contributed by the community.
4343
The current stable version of the Debug Toolbar is 5.0.0-alpha. It works on
4444
Django ≥ 4.2.0.
4545

46-
The Debug Toolbar does not currently support `Django's asynchronous views
47-
<https://docs.djangoproject.com/en/dev/topics/async/>`_.
46+
The Debug Toolbar has experimental support for `Django's asynchronous views
47+
<https://docs.djangoproject.com/en/dev/topics/async/>`_. Please note that
48+
the Debug Toolbar still lacks the capability for handling concurrent requests.
49+
If you find any issues, please report them on the `issue tracker`_.
4850

4951
Documentation, including installation and configuration instructions, is
5052
available at https://django-debug-toolbar.readthedocs.io/.
@@ -56,3 +58,4 @@ The Django Debug Toolbar was originally created by Rob Hudson <[email protected]>
5658
in August 2008 and was further developed by many contributors_.
5759

5860
.. _contributors: https://github.com/django-commons/django-debug-toolbar/graphs/contributors
61+
.. _issue tracker: https://github.com/django-commons/django-debug-toolbar/issues

docs/changes.rst

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Pending
88
* Removed support for Python 3.8 as it has reached end of life.
99
* Converted to Django Commons PyPI release process.
1010
* Fixed a crash which occurred when using non-``str`` static file values.
11+
* Documented experimental async support.
1112

1213
5.0.0-alpha (2024-09-01)
1314
------------------------

docs/installation.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -245,11 +245,12 @@ And for Apache:
245245
Django Channels & Async
246246
^^^^^^^^^^^^^^^^^^^^^^^
247247

248-
The Debug Toolbar currently doesn't support Django Channels or async projects.
249-
If you are using Django channels and you are having issues getting panels to
250-
load, please review the documentation for the configuration option
251-
:ref:`RENDER_PANELS <RENDER_PANELS>`.
248+
The Debug Toolbar currently has experimental support for Django Channels and
249+
async projects. The Debug Toolbar is compatible with the following exceptions:
252250

251+
- Concurrent requests aren't supported
252+
- ``TimerPanel``, ``RequestPanel`` and ``ProfilingPanel`` can't be used
253+
in async contexts.
253254

254255
HTMX
255256
^^^^

0 commit comments

Comments
 (0)