Andy Mikhailenko avatar Andy Mikhailenko committed 064ca41

Added documentation.

Comments (0)

Files changed (1)

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
 
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.