add doc strings

buildingmotif/ingresses/base.py

@@ -41,21 +41,36 @@ def records(self) -> List[Record]:
         raise NotImplementedError("Must be overridden by subclass")
 
     def dump(self, path: PathLike):
+        """
+        Takes the contents of the records of this handler and writes them to a JSON file
+
+        :param path: path to write output file to
+        :type path: PathLike
+        """
         output_string = self.dumps()
         Path(path).write_text(output_string)
 
     def dumps(self) -> str:
+        """
+        Takes the contents of the records of this handler and writes them to a string
+        """
         records = [
             {"rtype": record.rtype, "fields": record.fields} for record in self.records
         ]
         return json.dumps(records)
 
     @classmethod
     def load(cls, path: PathLike):
+        """
+        Takes a file generated by 'dump' and creates a new ingress handler with those records
+        """
         return cls.loads(Path(path).read_text())
 
     @classmethod
     def loads(cls, s: str):
+        """
+        Takes the string output by 'dumps' and creates a new ingress handler with those records
+        """
         self = cls.__new__(cls)
         records = []
         for record in json.loads(s):