From d5ef7ff4d69b42458a748925b3894ee75499879a Mon Sep 17 00:00:00 2001 From: "Bart K. de Koning" Date: Fri, 5 Jul 2024 19:51:27 -0400 Subject: [PATCH 1/2] fixed order and grammatical number of panels in documentation --- docs/panels.rst | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/panels.rst b/docs/panels.rst index c9ea6bbf0..7892dcf94 100644 --- a/docs/panels.rst +++ b/docs/panels.rst @@ -9,17 +9,6 @@ Default built-in panels The following panels are enabled by default. -Alerts -~~~~~~~ - -.. class:: debug_toolbar.panels.alerts.AlertsPanel - -This panel shows alerts for a set of pre-defined cases: - -- Alerts when the response has a form without the - ``enctype="multipart/form-data"`` attribute and the form contains - a file input. - History ~~~~~~~ @@ -33,8 +22,8 @@ snapshot of the toolbar to view that request's stats. ``True`` or if the server runs with multiple processes, the History Panel will be disabled. -Version -~~~~~~~ +Versions +~~~~~~~~ .. class:: debug_toolbar.panels.versions.VersionsPanel @@ -80,19 +69,30 @@ SQL SQL queries including time to execute and links to EXPLAIN each query. -Template -~~~~~~~~ +Static files +~~~~~~~~~~~~ + +.. class:: debug_toolbar.panels.staticfiles.StaticFilesPanel + +Used static files and their locations (via the ``staticfiles`` finders). + +Templates +~~~~~~~~~ .. class:: debug_toolbar.panels.templates.TemplatesPanel Templates and context used, and their template paths. -Static files -~~~~~~~~~~~~ +Alerts +~~~~~~~ -.. class:: debug_toolbar.panels.staticfiles.StaticFilesPanel +.. class:: debug_toolbar.panels.alerts.AlertsPanel -Used static files and their locations (via the ``staticfiles`` finders). +This panel shows alerts for a set of pre-defined cases: + +- Alerts when the response has a form without the + ``enctype="multipart/form-data"`` attribute and the form contains + a file input. Cache ~~~~~ @@ -101,8 +101,8 @@ Cache Cache queries. Is incompatible with Django's per-site caching. -Signal -~~~~~~ +Signals +~~~~~~~ .. class:: debug_toolbar.panels.signals.SignalsPanel From e284f2e91206ffd2a290f27d99e3c75b297e2ac7 Mon Sep 17 00:00:00 2001 From: "Bart K. de Koning" Date: Fri, 5 Jul 2024 20:22:00 -0400 Subject: [PATCH 2/2] updated changes.rst to reflect change to docs --- docs/changes.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/changes.rst b/docs/changes.rst index 952e6e996..d47f69784 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -4,6 +4,9 @@ Change log Pending ------- +* Changed ordering (and grammatical number) of panels and their titles in + documentation to match actual panel ordering and titles. + 4.4.5 (2024-07-05) ------------------