add doc

pannal · May 3, 2017 · 2d88efa · 2d88efa
1 parent b3da757
commit 2d88efa
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/Contents/Libraries/Shared/subzero/modification/processors/re_processor.py b/Contents/Libraries/Shared/subzero/modification/processors/re_processor.py
@@ -43,8 +43,9 @@ class MultipleWordReProcessor(ReProcessor):
     Expects a dictionary in the form of:
     dict = {
         "data": {"old_value": "new_value"},
-        "pattern": compiled re object that matches data
+        "pattern": compiled re object that matches data.keys()
     }
+    replaces found key in pattern with the corresponding value in data
     """
     def __init__(self, snr_dict, name=None, parent=None):
         super(ReProcessor, self).__init__(name=name)