Stefan Scherfke avatar Stefan Scherfke committed 1a15298

Documentation fixes

Comments (0)

Files changed (3)

 Our main development goals were:
 
 * Ease of use (simple API, little typing)
-* Memory and CPU efficiency
+* Efficiency:
 
   * No impact on simulation speed if you don’t use it.
   * As little impact as possible if you use it.
 Installation
 ------------
 
-The easiest way to install *Collectors* is via *PIP* or *distribute*::
+The easiest way to install *Collectors* is via 
+`PIP <http://pip.openplans.org/>`_ or 
+`distribute <http://packages.python.org/distribute/>`_::
 
     pip install Collectors
     

docs/collector.txt

     ([1], [8])
 
 
-Take-away
-^^^^^^^^^
+Summary
+^^^^^^^
 
 * Each variable is described by a *name*, a *collector function* and a *series*.
 * The *series* are ordered in the same way the ``(name, col_func)`` tuples were

docs/storages.txt

 data directly in an Excel file.
 
 To use this storage backend, you need to install ``xlwt`` (like “Excel
-Write”``xlrd`` (“Excel Read”) can be used to read from an Excel file):
+Write”); ``xlrd`` (“Excel Read”) can be used to read from an Excel file:
 
 .. sourcecode:: bash
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.