Added comment to explain ValidateContext.

benubois · benubois · commit 9515424e2fec · 2012-11-29T08:32:18.000-08:00
diff --git a/lib/html/pipeline/validate_context.rb b/lib/html/pipeline/validate_context.rb
@@ -2,6 +2,14 @@
 
 module HTML
   class Pipeline
+    # Singleton for tracking required context. 
+    # Required context can be pushed onto the internal @required_context Hash.
+    # For example:
+    #
+    #   ValidateContext.instance['HTML::Pipeline::CamoFilter'] = [:asset_host]
+    #
+    # The key needs to be the name of the class that requires the context
+    # specified as an array of symbols
     class ValidateContext
       include Singleton
    
@@ -20,7 +28,6 @@ def [](key)
       def []=(key, value)
         @required_context[key] = value
       end
-        
     end
   end
 end
