Skip to content

Commit 699c1d9

Browse files
authored
Fixed order and grammatical number of panels in documentation (#1956)
* fixed order and grammatical number of panels in documentation * updated changes.rst to reflect change to docs
1 parent dfad5db commit 699c1d9

File tree

2 files changed

+24
-21
lines changed

2 files changed

+24
-21
lines changed

docs/changes.rst

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ Change log
44
Pending
55
-------
66

7+
* Changed ordering (and grammatical number) of panels and their titles in
8+
documentation to match actual panel ordering and titles.
9+
710
4.4.5 (2024-07-05)
811
------------------
912

docs/panels.rst

+21-21
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,6 @@ Default built-in panels
99

1010
The following panels are enabled by default.
1111

12-
Alerts
13-
~~~~~~~
14-
15-
.. class:: debug_toolbar.panels.alerts.AlertsPanel
16-
17-
This panel shows alerts for a set of pre-defined cases:
18-
19-
- Alerts when the response has a form without the
20-
``enctype="multipart/form-data"`` attribute and the form contains
21-
a file input.
22-
2312
History
2413
~~~~~~~
2514

@@ -33,8 +22,8 @@ snapshot of the toolbar to view that request's stats.
3322
``True`` or if the server runs with multiple processes, the History Panel
3423
will be disabled.
3524

36-
Version
37-
~~~~~~~
25+
Versions
26+
~~~~~~~~
3827

3928
.. class:: debug_toolbar.panels.versions.VersionsPanel
4029

@@ -80,19 +69,30 @@ SQL
8069

8170
SQL queries including time to execute and links to EXPLAIN each query.
8271

83-
Template
84-
~~~~~~~~
72+
Static files
73+
~~~~~~~~~~~~
74+
75+
.. class:: debug_toolbar.panels.staticfiles.StaticFilesPanel
76+
77+
Used static files and their locations (via the ``staticfiles`` finders).
78+
79+
Templates
80+
~~~~~~~~~
8581

8682
.. class:: debug_toolbar.panels.templates.TemplatesPanel
8783

8884
Templates and context used, and their template paths.
8985

90-
Static files
91-
~~~~~~~~~~~~
86+
Alerts
87+
~~~~~~~
9288

93-
.. class:: debug_toolbar.panels.staticfiles.StaticFilesPanel
89+
.. class:: debug_toolbar.panels.alerts.AlertsPanel
9490

95-
Used static files and their locations (via the ``staticfiles`` finders).
91+
This panel shows alerts for a set of pre-defined cases:
92+
93+
- Alerts when the response has a form without the
94+
``enctype="multipart/form-data"`` attribute and the form contains
95+
a file input.
9696

9797
Cache
9898
~~~~~
@@ -101,8 +101,8 @@ Cache
101101

102102
Cache queries. Is incompatible with Django's per-site caching.
103103

104-
Signal
105-
~~~~~~
104+
Signals
105+
~~~~~~~
106106

107107
.. class:: debug_toolbar.panels.signals.SignalsPanel
108108

0 commit comments

Comments
 (0)