docs: add docstrings to the input module

Loop3D · Jul 10, 2024 · 4f73437 · 4f73437
1 parent e412abe
commit 4f73437
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/LoopDataConverter/input/input_data.py b/LoopDataConverter/input/input_data.py
@@ -5,13 +5,30 @@
 
 @dataclass
 class InputData:
+    """ Class to store input data for the loop data converter
+    
+    Attributes:
+    geology: Datatype.GEOLOGY = None 
+    structure: Datatype.STRUCTURE = None
+    fault: Datatype.FAULT = None
+    fold: Datatype.FOLD = None
+    
+    """
     geology: Datatype.GEOLOGY = None
     structure: Datatype.STRUCTURE = None
     fault: Datatype.FAULT = None
     fold: Datatype.FOLD = None
 
 
     def __getitem__(self, datatype: Datatype):
+        """ Method to get the the file directory of a datatype
+
+        Parameters:
+            datatype (Datatype): The datatype to get the file directory of
+
+        Returns:
+            The file directory of the datatype
+        """
 
         return self.__dict__[datatype]