From: W. Trevor King Date: Tue, 11 Oct 2011 17:51:45 +0000 (-0400) Subject: Add motivational blurb to command_stack docstring. X-Git-Url: http://git.tremily.us/?p=hooke.git;a=commitdiff_plain;h=a0fcb0c8b9f01df1d280c8284daa5f72b5b9071e Add motivational blurb to command_stack docstring. --- diff --git a/hooke/command_stack.py b/hooke/command_stack.py index 202e599..69bee4b 100644 --- a/hooke/command_stack.py +++ b/hooke/command_stack.py @@ -18,6 +18,16 @@ """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