Skip to content

Fixed order and grammatical number of panels in documentation #1956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 6, 2024
Merged

Fixed order and grammatical number of panels in documentation #1956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5ef7ff
fixed order and grammatical number of panels in documentation
bkdekoning Jul 5, 2024
e284f2e
updated changes.rst to reflect change to docs
bkdekoning Jul 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
------------------

Expand Down
42 changes: 21 additions & 21 deletions docs/panels.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~

Expand All @@ -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

Expand Down Expand Up @@ -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
~~~~~
Expand All @@ -101,8 +101,8 @@ Cache

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

Signal
~~~~~~
Signals
~~~~~~~

.. class:: debug_toolbar.panels.signals.SignalsPanel

Expand Down