Doc string for ProcessingState.

diff --git a/mediagoblin/processing/__init__.py b/mediagoblin/processing/__init__.py
index a1fd3fb74f869bf28f13a49261bd96f23e158f05..f3a85940ca74f454e49932f99f0bb95330c4f7a5 100644 (file)
--- a/mediagoblin/processing/__init__.py
+++ b/mediagoblin/processing/__init__.py
@@ -75,6 +75,14 @@ class FilenameBuilder(object):
 
 
 class ProcessingState(object):
+    """
+    The first and only argument to the "processor" of a media type
+
+    This could be thought of as a "request" to the processor
+    function. It has the main info for the request (media entry)
+    and a bunch of tools for the request on it.
+    It can get more fancy without impacting old media types.
+    """
     def __init__(self, entry):
         self.entry = entry
         self.workbench = None