ProcessingState: Document monkey patching.

diff --git a/mediagoblin/processing/__init__.py b/mediagoblin/processing/__init__.py
index 738378b89717c18f58eda927d0327fa4707e9463..1760d0b93bc83581eefe29150bf4c0cd7053449f 100644 (file)
--- a/mediagoblin/processing/__init__.py
+++ b/mediagoblin/processing/__init__.py
@@ -81,6 +81,16 @@ class ProcessingState(object):
         self.queued_filename = None
 
         # Monkey patch us onto the entry
+        # This is needed to keep the current calling convention
+        # for processors:
+        #   def process_FOO(entry):
+        #     proc_state = entry.proc_state
+        #     workbench = proc_state.workbench
+        # When all processors use the new stuff, they should be
+        # rewritten:
+        #   def process_FOO(proc_state):
+        #     entry = proc_state.entry
+        #     workbench = proc_state.workbench
         entry.proc_state = self
 
     def set_workbench(self, wb):