Improved RENDER_PANELS documentation and change log.

Author: tim-schilling

docs/changes.rst

@@ -9,9 +9,10 @@ Next version
 * Added ``PRETTIFY_SQL`` configuration option to support controlling
   SQL token grouping. By default it's set to True. When set to False,
   a performance improvement can be seen by the SQL panel.
-* ``HistoryPanel`` will be disabled when ``RENDER_PANELS`` is ``True``
-  or if it's not set, but the server is running with multiple processes.
-* Fixes ``RENDER_PANELS`` functionality so that when ``True`` panels are
+* Disabled ``HistoryPanel`` when ``RENDER_PANELS`` is ``True``
+  or if ``RENDER_PANELS`` is ``None`` and the WSGI container is
+  running with multiple processes.
+* Fixed ``RENDER_PANELS`` functionality so that when ``True`` panels are
   rendered during the request and not loaded asynchronously.
 
 

docs/configuration.rst

@@ -73,14 +73,17 @@ Toolbar options
   Default: ``None``
 
   If set to ``False``, the debug toolbar will keep the contents of panels in
-  memory on the server and load them on demand. If set to ``True``, it will
-  render panels inside every page. This may slow down page rendering but it's
+  memory on the server and load them on demand.
+
+  If set to ``True``, it will disable ``HistoryPanel`` and render panels
+  inside every page. This may slow down page rendering but it's
   required on multi-process servers, for example if you deploy the toolbar in
   production (which isn't recommended).
 
   The default value of ``None`` tells the toolbar to automatically do the
   right thing depending on whether the WSGI container runs multiple processes.
-  This setting allows you to force a different behavior if needed.
+  This setting allows you to force a different behavior if needed. If the
+  WSGI container runs multiple processes, it will disable ``HistoryPanel``.
 
 * ``RESULTS_CACHE_SIZE``