Add motivational blurb to command_stack docstring.
authorW. Trevor King <wking@drexel.edu>
Tue, 11 Oct 2011 17:51:45 +0000 (13:51 -0400)
committerW. Trevor King <wking@drexel.edu>
Tue, 11 Oct 2011 17:51:45 +0000 (13:51 -0400)
hooke/command_stack.py

index 202e599..69bee4b 100644 (file)
 
 """The ``command_stack`` module provides tools for managing and
 executing stacks of :class:`~hooke.engine.CommandMessage`\s.
+
+In experiment analysis, the goal is to construct a
+:class:`~hooke.command_stack.CommandStack` that starts with your raw
+experiment data and ends with your analyzed results.  These
+:class:`~hooke.command_stack.CommandStack`\s are stored in your
+:class:`~hooke.playlist.FilePlaylist`, so they are saved to disk with
+the analysis results.  This means you will always have a record of
+exactly how you processed the raw data to produce your analysis
+results, which makes it easy to audit your approach or go back and
+reanalyze older data.
 """
 
 import os