aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAymeric Augustin2013-11-24 11:26:07 +0100
committerAymeric Augustin2013-11-24 11:26:07 +0100
commit908b49cb7d2d527b701996f0d0b9e1e19e765819 (patch)
tree545635570f264761d7314aa761cd36d1e6a56f7c /docs
parente7692b33ca7fd3f7704d283d6b1368cdea198d59 (diff)
downloaddjango-debug-toolbar-908b49cb7d2d527b701996f0d0b9e1e19e765819.tar.bz2
Rename some settings for clarity and consistency.
Thanks Jannis for his help.
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.rst40
1 files changed, 20 insertions, 20 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst
index 7849d2e..eebb6e9 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -41,6 +41,13 @@ toolbar itself, others are specific to some panels.
Toolbar options
~~~~~~~~~~~~~~~
+* ``INSERT_BEFORE``
+
+ Default: ``'</body>'``
+
+ The toolbar searches for this string in the HTML and inserts itself just
+ before.
+
* ``RENDER_PANELS``
Default: ``None``
@@ -55,13 +62,13 @@ Toolbar options
right thing depending on whether the WSGI container runs multiple processes.
This setting allows you to force a different behavior if needed.
-* ``RESULTS_CACHE_SIZE``
+* ``RESULTS_STORE_SIZE``
Default: ``10``
The toolbar keeps up to this many results in memory.
-* ``ROOT_TAG_ATTRS``
+* ``ROOT_TAG_EXTRA_ATTRS``
Default: ``''``
@@ -88,13 +95,6 @@ Toolbar options
which contains your custom logic. This method should return ``True`` or
``False``.
-* ``TAG``
-
- Default: ``'body'``
-
- If set, this will be the closing tag to which the debug toolbar will attach
- itself.
-
Panel options
~~~~~~~~~~~~~
@@ -117,25 +117,25 @@ Panel options
calls. Enabling stacktraces can increase the CPU time used when executing
queries.
-* ``HIDDEN_STACKTRACE_MODULES``
+* ``HIDE_DJANGO_SQL``
- Default: ``('socketserver', 'threading', 'wsgiref', 'debug_toolbar')``. The
- first value is ``socketserver`` on Python 3 and ``SocketServer`` on Python
- 2.
+ Default: ``True``
Panels: cache, SQL
- Useful for eliminating server-related entries which can result
- in enormous DOM structures and toolbar rendering delays.
+ If set to ``True`` then code in Django itself won't be shown in
+ stacktraces.
-* ``HIDE_DJANGO_SQL``
+* ``HIDE_IN_STACKTRACES``
- Default: ``True``
+ Default: ``('socketserver', 'threading', 'wsgiref', 'debug_toolbar')``. The
+ first value is ``socketserver`` on Python 3 and ``SocketServer`` on Python
+ 2.
Panels: cache, SQL
- If set to ``True`` then code in Django itself won't be shown in
- stacktraces.
+ Useful for eliminating server-related entries which can result
+ in enormous DOM structures and toolbar rendering delays.
* ``INTERCEPT_REDIRECTS``
@@ -177,5 +177,5 @@ Here's an example::
'HIDE_DJANGO_SQL': False,
'TAG': 'div',
'ENABLE_STACKTRACES': True,
- 'HIDDEN_STACKTRACE_MODULES': ('gunicorn', 'newrelic'),
+ 'HIDE_IN_STACKTRACES': ('gunicorn', 'newrelic'),
}