added doc strings to methods that need to be implemented

AllenInstitute · Jan 3, 2018 · cebfc58 · cebfc58
1 parent 27d2035
commit cebfc58
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/argschema/sources/source.py b/argschema/sources/source.py
@@ -107,6 +107,7 @@ def get_config(ConfigSchema, d):
 
 class ArgSource(ConfigurableSource):
     def get_dict(self):
+    """method that must be implemented to enable an ArgSource to return a dictionary"""
         pass
 
 
@@ -143,4 +144,11 @@ def get_input_from_config(ArgSource, config_d):
 
 class ArgSink(ConfigurableSource):
     def put_dict(self, d):
+        """method that must be implemented to enable an ArgSink to write a dictionary
+        
+        Parameters
+        ----------
+        d: dict
+            the dictionary to write
+        """
         pass