Tweak the trim whitespace plugin documentation.

- Fix code highlighting
- Wrap all lines to 80 chars
- Add more markup (eg. Response() to ``Response()``)

diff --git a/mediagoblin/plugins/trim_whitespace/README.rst b/mediagoblin/plugins/trim_whitespace/README.rst
index b55ce35ea7719f834cd5d518cc70c7016c096b86..db9a0c53700b4e67342b54ed12eb536171b1ec7e 100644 (file)
--- a/mediagoblin/plugins/trim_whitespace/README.rst
+++ b/mediagoblin/plugins/trim_whitespace/README.rst
@@ -3,17 +3,22 @@
 =======================
 
 Mediagoblin templates are written with 80 char limit for better
-readability. However that means that the html output is very verbose
-containing LOTS of whitespace. This plugin inserts a Middleware that
-filters out whitespace from the returned HTML in the Response() objects.
+readability. However that means that the HTML output is very verbose
+containing *lots* of whitespace. This plugin inserts a middleware that
+filters out whitespace from the returned HTML in the ``Response()``
+objects.
 
-Simply enable this plugin by putting it somewhere where python can reach it and put it's path into the [plugins] section of your mediagoblin.ini or mediagoblin_local.ini like for example this:
+Simply enable this plugin by putting it somewhere where Python can reach
+it and put it's path into the ``[plugins]`` section of your
+``mediagoblin.ini`` or ``mediagoblin_local.ini`` like for example this:
+
+.. code-block:: ini
 
     [plugins]
     [[mediagoblin.plugins.trim_whitespace]]
 
 There is no further configuration required. If this plugin is enabled,
-all text/html documents should not have lots of whitespace in between
+all *text/html* documents should not have lots of whitespace in between
 elements, although it does a very naive filtering right now (just keep
 the first whitespace and delete all subsequent ones).