openstack/deb-python-django-compressor
Code Issues Proposed changes

Tweaked documentation about COMPRESS wrt. DEBUG. Made it much clearer that in order to get Exceptions when DEBUG is True, COMPRESS needs to be enabled explicitly.

Browse Source
This commit is contained in:
Jaap Roes
2011-04-15 05:06:57 +08:00
committed by Jannis Leidel
parent cc43defa36
commit 1f68326b87
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/settings.txt
View File

@@ -13,7 +13,8 @@ COMPRESS
:Default: the opposite of ``DEBUG``
Boolean that decides if compression will happen.
Boolean that decides if compression will happen. In order to test compression
when ``DEBUG`` is enabled COMPRESS needs to explicitly be set to ``True``.
.. _compress_url:

10
docs/usage.txt
View File

@@ -47,12 +47,14 @@ Which would be rendered something like:
<script type="text/javascript" src="/static/CACHE/js/3f33b9146e12.js" charset="utf-8"></script>
Linked files **must** be accesible via :ref:`COMPRESS_URL <compress_url>`.
If DEBUG is ``True``, off-site files will throw exceptions. If DEBUG is
``False`` they will be silently stripped.
If the :ref:`COMPRESS <compress>` setting is ``False`` (defaults to the
opposite of DEBUG) the ``compress`` template tag simply returns exactly
what it was given, to ease development.
opposite of DEBUG) the ``compress`` template tag does nothing and simply returns
exactly what it was given.
If both DEBUG and :ref:`COMPRESS <compress>` are set to ``True``, uncompressable
files (off-site or non existent) will throw and exception. If DEBUG is ``False``
these files will be silently stripped.
.. warning::