From bc5aad0783ca3faa031b8bdc6fe90e17094dfda4 Mon Sep 17 00:00:00 2001 From: John-Scott Atlakson Date: Sun, 12 Jun 2011 10:04:05 -0400 Subject: [PATCH] Corrected doc typos --- docs/behind-the-scenes.txt | 2 +- docs/installation.txt | 2 +- docs/settings.txt | 4 ++-- docs/usage.txt | 10 +++++----- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/behind-the-scenes.txt b/docs/behind-the-scenes.txt index 62b4315..b82edd6 100644 --- a/docs/behind-the-scenes.txt +++ b/docs/behind-the-scenes.txt @@ -22,7 +22,7 @@ Everything stops here if the cache entry exists. Second step: parsing and file list ---------------------------------- -A compressor instance is created, which in turns instanciates the HTML parser. +A compressor instance is created, which in turns instantiates the HTML parser. The parser is used to determine a file or code hunk list. Each file mtime is checked, first in cache and then on disk/storage, and this is used to determine an unique cache key. diff --git a/docs/installation.txt b/docs/installation.txt index 6f0583c..6fa198f 100644 --- a/docs/installation.txt +++ b/docs/installation.txt @@ -13,7 +13,7 @@ Installation ) * See the list of :ref:`settings` to modify Django Compressor's - default behaviour and make adjustements for your website. + default behaviour and make adjustments for your website. * In case you use Django 1.3's staticfiles_ contrib app (or its standalone counterpart django-staticfiles_) you have to add Django Compressor's file diff --git a/docs/settings.txt b/docs/settings.txt index 6bf4c19..6d5e872 100644 --- a/docs/settings.txt +++ b/docs/settings.txt @@ -130,7 +130,7 @@ A list of filters that will be applied to javascript. Possible options are: ``compressor.filters.jsmin.JSMinFilter`` """"""""""""""""""""""""""""""""""""""""" -A filter that uses the jsmin implementation rJSmin_ to compess JavaScript code. +A filter that uses the jsmin implementation rJSmin_ to compress JavaScript code. ``compressor.filters.closure.ClosureCompilerFilter`` """""""""""""""""""""""""""""""""""""""""""""""""""" @@ -257,7 +257,7 @@ back to ``HtmlParser`` if ``lxml`` is not available. ``LxmlParser`` is the fastest available parser, but ``HtmlParser`` is not much slower. ``AutoSelectParser`` adds a slight overhead, but in most cases it -won't be necesarry to change the default parser. +won't be necessary to change the default parser. The other two included parsers are considerably slower and should only be used if absolutely necessary. diff --git a/docs/usage.txt b/docs/usage.txt index 316cd87..fa8727d 100644 --- a/docs/usage.txt +++ b/docs/usage.txt @@ -46,14 +46,14 @@ Which would be rendered something like: -Linked files **must** be accesible via :ref:`COMPRESS_URL `. +Linked files **must** be accessible via :ref:`COMPRESS_URL `. If the :ref:`COMPRESS ` setting is ``False`` (defaults to the 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`` +If both DEBUG and :ref:`COMPRESS ` are set to ``True``, incompressible +files (off-site or non existent) will throw an exception. If DEBUG is ``False`` these files will be silently stripped. .. warning:: @@ -64,7 +64,7 @@ these files will be silently stripped. :ref:`COMPRESS_CACHE_BACKEND ` and Django's `caching documentation`_). -The compress template tag supports a second arguemnt specifying the output +The compress template tag supports a second argument specifying the output mode and defaults to saving the result in a file. Alternatively you can pass '``inline``' to the template tag to return the content directly to the rendered page, e.g.: @@ -93,7 +93,7 @@ would be rendered something like:: Pre-compression --------------- -Django Compressor comes with an optional ``compress`` mangement command to +Django Compressor comes with an optional ``compress`` management command to run the compression outside of the request/response loop -- independent from user requests. This allows to pre-compress CSS and JavaScript files and works just like the automatic compression with the ``{% compress %}`` tag.