From e6bd03d429a523644513b1fb094521c2f6861973 Mon Sep 17 00:00:00 2001 From: Elrond Date: Mon, 22 Apr 2013 22:17:41 +0200 Subject: [PATCH] Doc string for ProcessingState. --- mediagoblin/processing/__init__.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/mediagoblin/processing/__init__.py b/mediagoblin/processing/__init__.py index a1fd3fb7..f3a85940 100644 --- 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 -- 2.25.1