diff --git a/docs/settings.txt b/docs/settings.txt index 97cbe76..2cd15f7 100644 --- a/docs/settings.txt +++ b/docs/settings.txt @@ -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: diff --git a/docs/usage.txt b/docs/usage.txt index 59e687d..316cd87 100644 --- a/docs/usage.txt +++ b/docs/usage.txt @@ -47,12 +47,14 @@ Which would be rendered something like: Linked files **must** be accesible via :ref:`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 ` 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 ` 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::