Commits

Andy Mikhailenko  committed 064ca41

Added documentation.

  • Participants
  • Parent commits d27e4ec

Comments (0)

Files changed (1)

File monk/manipulation.py

 
 
 class ValueMerger(object):
+    """ Base class for value mergers.
+    """
     def __init__(self, spec, value):
         self.spec = spec
         self.value = value
 
     def check(self):
+        """ Returns ``True`` if this merger can handle given spec/value pair,
+        otherwise returns ``False``.
+
+        Subclasses must overload this method.
+        """
         raise NotImplementedError
 
     def process(self):
+        """ Returns a merged version or `self.spec` and `self.value`.
+
+        Subclasses must overload this method.
+        """
         raise NotImplementedError